com.hcl.domino.keep.dbfunctions

Class DocumentFunctions

java.lang.Object

com.hcl.domino.keep.dbfunctions.DocumentFunctions

public class DocumentFunctions
extends java.lang.Object

Helper functions for converting documents to JSON and JSON to documents. Mostly to relieve complexity in KeepJNXSession

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_ASSIGNEDTO
static java.lang.String	FIELD_CHAIR
static java.lang.String	FIELD_DOLL_INET_CHAIR
static java.lang.String	FIELD_DOLL_UPDATEDBY
static java.lang.String	FIELD_FROM
static java.lang.String	FIELD_FYIASSIGNEDTO
static java.lang.String	FIELD_INET_FROM
static java.lang.String	FIELD_INET_FYI_NAMES
static java.lang.String	FIELD_INET_OPTIONAL_NAMES
static java.lang.String	FIELD_INET_REQUIRED_NAMES
static java.lang.String	FIELD_INET_SEND_TO
static java.lang.String	FIELD_OPTIONAL_ASSIGNEDTO
static java.lang.String	FIELD_PRINCIPAL
static java.lang.String	FIELD_SEND_TO

Method Summary

Modifier and Type	Method and Description
static io.vertx.core.json.JsonArray	convertToList(java.lang.String key, io.vertx.core.json.JsonObject source) Validate and/or convert values into list format
static boolean	decryptDocument(KeepJnxSession session, com.hcl.domino.data.Document doc, java.lang.String jwtClaim)
static java.util.Optional<java.lang.Object>	getCalendarFromJson(io.vertx.core.json.JsonObject jsonSource, java.lang.String key) Returns a Optional calendarEntry from a JsonObject, empty if it isn’t Date/Time Needs to be Object, not calendar for additional processing in .orElse
static java.util.Optional<com.hcl.domino.data.Document>	getDocFromCollectionEntry(com.hcl.domino.data.Database db, com.hcl.domino.data.CollectionEntry entry) Returns a document, current or soft deleted
static io.vertx.core.json.JsonObject	getDocumentResult(com.hcl.domino.data.Document doc, DbRequestParameters<io.vertx.core.json.JsonObject> request) Retrieves and updates and document output result
static boolean	looksLikeIso8601(java.lang.String source) Checks loosly if a string matches IS8601 datetime format YYYY-MM-DDTHH:mm:ss.sssZ
static boolean	processAdditionalFields(com.hcl.domino.data.Database parentDB, com.hcl.domino.data.Document doc, java.util.Map.Entry<java.lang.String,java.lang.Object> entry) Stores special AdditionalFields Json Object as text item in a Notes Document CounterIntuitive: Returns TRUE if NO processing happened, so the Stream processing can continue
static boolean	processArrayValue(com.hcl.domino.data.Document doc, java.util.Map.Entry<java.lang.String,java.lang.Object> entry) Stores Json Array values as multi-value item in a Notes Document CounterIntuitive: Returns TRUE if NO processing happened, so the Stream processing can continue
static boolean	processBooleanValue(com.hcl.domino.data.Document doc, java.util.Map.Entry<java.lang.String,java.lang.Object> entry) Stores a boolean value as 0 or 1 integer in item in a Notes Document CounterIntuitive: Returns TRUE if NO processing happened, so the Stream processing can continue
static boolean	processJsonValue(com.hcl.domino.data.Document doc, java.util.Map.Entry<java.lang.String,java.lang.Object> entry) Stores Json Object as text item in a Notes Document CounterIntuitive: Returns TRUE if NO processing happened, so the Stream processing can continue
static boolean	removeDeletedItem(com.hcl.domino.data.Document doc, java.util.Map.Entry<java.lang.String,java.lang.Object> entry) Removes an item from the document id the value is null.
static void	saveItemToDoc(com.hcl.domino.data.Document doc, io.vertx.core.json.JsonObject jsonSource, java.util.Map.Entry<java.lang.String,java.lang.Object> entry) Saves an item into the Notes document as either string or calendar

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_ASSIGNEDTO

public static final java.lang.String FIELD_ASSIGNEDTO

See Also:

Constant Field Values

FIELD_OPTIONAL_ASSIGNEDTO

public static final java.lang.String FIELD_OPTIONAL_ASSIGNEDTO

See Also:

Constant Field Values

FIELD_INET_REQUIRED_NAMES

public static final java.lang.String FIELD_INET_REQUIRED_NAMES

See Also:

Constant Field Values

FIELD_INET_OPTIONAL_NAMES

public static final java.lang.String FIELD_INET_OPTIONAL_NAMES

See Also:

Constant Field Values

FIELD_FYIASSIGNEDTO

public static final java.lang.String FIELD_FYIASSIGNEDTO

See Also:

Constant Field Values

FIELD_INET_FYI_NAMES

public static final java.lang.String FIELD_INET_FYI_NAMES

See Also:

Constant Field Values

FIELD_CHAIR

public static final java.lang.String FIELD_CHAIR

See Also:

Constant Field Values

FIELD_DOLL_INET_CHAIR

public static final java.lang.String FIELD_DOLL_INET_CHAIR

See Also:

Constant Field Values

FIELD_PRINCIPAL

public static final java.lang.String FIELD_PRINCIPAL

See Also:

Constant Field Values

FIELD_FROM

public static final java.lang.String FIELD_FROM

See Also:

Constant Field Values

FIELD_INET_FROM

public static final java.lang.String FIELD_INET_FROM

See Also:

Constant Field Values

FIELD_SEND_TO

public static final java.lang.String FIELD_SEND_TO

See Also:

Constant Field Values

FIELD_INET_SEND_TO

public static final java.lang.String FIELD_INET_SEND_TO

See Also:

Constant Field Values

FIELD_DOLL_UPDATEDBY

public static final java.lang.String FIELD_DOLL_UPDATEDBY

See Also:

Constant Field Values

Method Detail

convertToList

public static io.vertx.core.json.JsonArray convertToList(java.lang.String key,
                                                         io.vertx.core.json.JsonObject source)

Validate and/or convert values into list format

Parameters:

key -

source -

Returns:

result in list

decryptDocument

public static boolean decryptDocument(KeepJnxSession session,
                                      com.hcl.domino.data.Document doc,
                                      java.lang.String jwtClaim)

Parameters:

session -

doc -

jwtClaim -

Returns:

a decrypted document if successful

getCalendarFromJson

public static java.util.Optional<java.lang.Object> getCalendarFromJson(io.vertx.core.json.JsonObject jsonSource,
                                                                       java.lang.String key)

Returns a Optional calendarEntry from a JsonObject, empty if it isn’t Date/Time Needs to be Object, not calendar for additional processing in .orElse

Parameters:

jsonSource - JsonObject with DateTime ISO

key - Key to DT

Returns:

Calendar entry or null

getDocFromCollectionEntry

public static java.util.Optional<com.hcl.domino.data.Document> getDocFromCollectionEntry(com.hcl.domino.data.Database db,
                                                                                         com.hcl.domino.data.CollectionEntry entry)

Returns a document, current or soft deleted

Parameters:

db - Database

entry - CollectionEntry

Returns:

document or null

getDocumentResult

public static io.vertx.core.json.JsonObject getDocumentResult(com.hcl.domino.data.Document doc,
                                                              DbRequestParameters<io.vertx.core.json.JsonObject> request)

Retrieves and updates and document output result

Parameters:

doc -

request -

Returns:

updated document output

looksLikeIso8601

public static boolean looksLikeIso8601(java.lang.String source)

Checks loosly if a string matches IS8601 datetime format YYYY-MM-DDTHH:mm:ss.sssZ

Parameters:

source - the suspect

Returns:

true if it looks like a date

processAdditionalFields

public static boolean processAdditionalFields(com.hcl.domino.data.Database parentDB,
                                              com.hcl.domino.data.Document doc,
                                              java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Stores special AdditionalFields Json Object as text item in a Notes Document CounterIntuitive: Returns TRUE if NO processing happened, so the Stream processing can continue

Parameters:

parentDB - the database the document came from

doc - destination to store values in

entry - key/value to process if it is an array

Returns:

true if stream processing needs to continue, false if it was processes

processArrayValue

public static boolean processArrayValue(com.hcl.domino.data.Document doc,
                                        java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Stores Json Array values as multi-value item in a Notes Document CounterIntuitive: Returns TRUE if NO processing happened, so the Stream processing can continue

Parameters:

doc - destination to store values in

entry - key/value to process if it is an array

Returns:

true if stream processing needs to continue, false if it was processes

processBooleanValue

public static boolean processBooleanValue(com.hcl.domino.data.Document doc,
                                          java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Stores a boolean value as 0 or 1 integer in item in a Notes Document CounterIntuitive: Returns TRUE if NO processing happened, so the Stream processing can continue

Parameters:

doc - destination to store values in

entry - key/value to process if it is an array

Returns:

true if stream processing needs to continue, false if it was processes

processJsonValue

public static boolean processJsonValue(com.hcl.domino.data.Document doc,
                                       java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Stores Json Object as text item in a Notes Document CounterIntuitive: Returns TRUE if NO processing happened, so the Stream processing can continue

Parameters:

doc - destination to store values in

entry - key/value to process if it is an array

Returns:

true if stream processing needs to continue, false if it was processes

removeDeletedItem

public static boolean removeDeletedItem(com.hcl.domino.data.Document doc,
                                        java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Removes an item from the document id the value is null. CounterIntuitive: Returns TRUE if NO REMOVAL happened, so the Stream processing can continue

Parameters:

doc - the document to store values in

entry - key/value with entry name/value

Returns:

true if stream continues, false if done

saveItemToDoc

public static void saveItemToDoc(com.hcl.domino.data.Document doc,
                                 io.vertx.core.json.JsonObject jsonSource,
                                 java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Saves an item into the Notes document as either string or calendar

Parameters:

doc - destination to store values in

jsonSource -

• JsonDocument to pull value from

entry - key/value