com.hcl.domino.keep.info

Class KeepApplicationConfigInfo

java.lang.Object

com.hcl.domino.keep.info.KeepApplicationConfigInfo

public class KeepApplicationConfigInfo
extends java.lang.Object

Class to hold config info about an external application using Keep. This holds the app’sa name, salted hashed secret, Keep databases accessible, status and application approvers (for future functionality)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeepApplicationConfigInfo.ApplicationStatus Enum for Application Status, corresponding to enum in the OpenAPI spec

Constructor Summary

Constructors

Constructor and Description
KeepApplicationConfigInfo() Default constructor
KeepApplicationConfigInfo(java.lang.String appName, java.util.List<java.lang.String> databasesRequested, java.lang.String author)

Method Summary

Modifier and Type	Method and Description
static KeepApplicationConfigInfo	fromDocument(com.hcl.domino.data.Document doc)
static KeepApplicationConfigInfo	fromJson(io.vertx.core.json.JsonObject payload) Creates a ApplicationConfig from JSON, both from bakup or newly created
java.lang.String	getAppDescription() Gets the application’s description
java.lang.String	getAppIcon() Base64 encoded image to be used for the database icon.
java.lang.String	getAppId() Gets the application ID generated by Keep for the external application
java.util.List<java.lang.String>	getApplicationApprovers() Gets the list of external approvers who need to / have approved access to the Keep databases requested
java.lang.String	getAppName() Gets the name the user has chosen for the external application.
java.lang.String	getAppSecret() Gets the application secret generated by Keep for the external application
KeepApplicationConfigInfo.ApplicationStatus	getAppStatus() Gets external application status as an enum
java.lang.String	getAuthor() Gets the person who created the external application
java.util.List<java.lang.String>	getDatabasesRequested() Gets the list of Keep databases this external application has or would like access to
java.lang.String	getUnid() Gets universalID of the document for this keep database config
KeepApplicationConfigInfo	save(KeepJnxSession s, com.hcl.domino.data.Database db, KeepFactory factory)
void	setAppDescription(java.lang.String appDescription) Sets the application description
void	setAppId(java.lang.String appId) Sets the application ID for the external application.
void	setApplicationApprovers(java.util.List<java.lang.String> list) Sets the list of external approvers who need to / have approved access to the Keep databases requested
void	setAppName(java.lang.String appName) Sets the name the user has chosen for the external application.
void	setAppSecret(java.lang.String appSecret) Sets the application secret generated by Keep for the external application
void	setAppStatus(KeepApplicationConfigInfo.ApplicationStatus appStatus) Gets external application status as an enum
void	setAppStatus(java.lang.String appStatus) Using a string value, sets the application status
void	setAuthor(java.lang.String author) Sets the person who created the external application
void	setDatabasesRequested(java.util.ArrayList<java.lang.String> databasesRequested) Sets the list of Keep databases this external application has or would like access to
void	setIcon(java.lang.String appIcon) Sets the image icon to be used for the database in Keep.
void	setUnid(java.lang.String unid) Sets universalID of the document for this keep database config
io.vertx.core.json.JsonObject	toJson()

Methods inherited from class java.lang.Object

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

Constructor Detail

KeepApplicationConfigInfo

public KeepApplicationConfigInfo()

Default constructor

KeepApplicationConfigInfo

public KeepApplicationConfigInfo(java.lang.String appName,
                                 java.util.List<java.lang.String> databasesRequested,
                                 java.lang.String author)

Parameters:

appName -

databasesRequested -

author -

Method Detail

fromDocument

public static KeepApplicationConfigInfo fromDocument(com.hcl.domino.data.Document doc)

Parameters:

doc -

Returns:

as App config

fromJson

public static KeepApplicationConfigInfo fromJson(io.vertx.core.json.JsonObject payload)

Creates a ApplicationConfig from JSON, both from bakup or newly created

Parameters:

payload -

Returns:

ApplicationConfigInfo

getAppDescription

public java.lang.String getAppDescription()

Gets the application’s description

Returns:

external application description

getAppIcon

public java.lang.String getAppIcon()

Base64 encoded image to be used for the database icon. Preferably svg for better resizing.

Returns:

appIcon image

getAppId

public java.lang.String getAppId()

Gets the application ID generated by Keep for the external application

Returns:

application’s unique ID

getApplicationApprovers

public java.util.List<java.lang.String> getApplicationApprovers()

Gets the list of external approvers who need to / have approved access to the Keep databases requested

Returns:

list of approver names

getAppName

public java.lang.String getAppName()

Gets the name the user has chosen for the external application. Not necessarily unique

Returns:

name of the application

getAppSecret

public java.lang.String getAppSecret()

Gets the application secret generated by Keep for the external application

Returns:

application’s unique secret, salted

getAppStatus

public KeepApplicationConfigInfo.ApplicationStatus getAppStatus()

Gets external application status as an enum

Returns:

application status enum

getAuthor

public java.lang.String getAuthor()

Gets the person who created the external application

Returns:

Keep username

getDatabasesRequested

public java.util.List<java.lang.String> getDatabasesRequested()

Gets the list of Keep databases this external application has or would like access to

Returns:

list of database names

getUnid

public java.lang.String getUnid()

Gets universalID of the document for this keep database config

Returns:

32-character hex string

save

public KeepApplicationConfigInfo save(KeepJnxSession s,
                                      com.hcl.domino.data.Database db,
                                      KeepFactory factory)

Parameters:

s -

db -

factory -

Returns:

fluent

setAppDescription

public void setAppDescription(java.lang.String appDescription)

Sets the application description

Parameters:

appDescription - external application description

setAppId

public void setAppId(java.lang.String appId)

Sets the application ID for the external application. Done for loading from a database

Parameters:

appId -

setApplicationApprovers

public void setApplicationApprovers(java.util.List<java.lang.String> list)

Sets the list of external approvers who need to / have approved access to the Keep databases requested

Parameters:

list -

setAppName

public void setAppName(java.lang.String appName)

Sets the name the user has chosen for the external application. Not necessarily unique param name of the application

Parameters:

appName -

setAppSecret

public void setAppSecret(java.lang.String appSecret)

Sets the application secret generated by Keep for the external application

Parameters:

appSecret - application’s unique secret, salted

setAppStatus

public void setAppStatus(KeepApplicationConfigInfo.ApplicationStatus appStatus)

Gets external application status as an enum

Parameters:

appStatus - application status enum

setAppStatus

public void setAppStatus(java.lang.String appStatus)

Using a string value, sets the application status

Parameters:

appStatus - as string

setAuthor

public void setAuthor(java.lang.String author)

Sets the person who created the external application

Parameters:

author - Keep username

setDatabasesRequested

public void setDatabasesRequested(java.util.ArrayList<java.lang.String> databasesRequested)

Sets the list of Keep databases this external application has or would like access to

Parameters:

databasesRequested -

setIcon

public void setIcon(java.lang.String appIcon)

Sets the image icon to be used for the database in Keep.

Parameters:

appIcon - Base64 encoded string image, preferably svg for better resizing.

setUnid

public void setUnid(java.lang.String unid)

Sets universalID of the document for this keep database config

Parameters:

unid -

toJson

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

Returns:

Gets the object as JSON