KeepConfigHolder

java.lang.Object
- java.lang.Enum<KeepConfigHolder>
- - com.hcl.domino.keep.config.KeepConfigHolder

All Implemented Interfaces:

KeepConfig, java.io.Serializable, java.lang.Comparable<KeepConfigHolder>
```
public enum KeepConfigHolder
extends java.lang.Enum<KeepConfigHolder>
implements KeepConfig
```

Enum Constant Summary

Enum Constants
Enum Constant and Description

INSTANCE
Singleton

Enum Constants
Enum Constant and Description
`INSTANCE` Singleton

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActiveAppId(java.lang.String appId)`
`KeepConfig`	`addKeepApiInfo(java.lang.String version, KeepApiInfo apiInfo)`
`KeepConfig`	`addKeepApiInfoFromOpenApiJson(java.lang.String version, io.vertx.core.json.JsonObject source)` Loads all API info objects from an openAPI 3.0 specification file in JSON format
`KeepConfig`	`addKeepDbInfo(java.lang.String apiName, KeepDbInfo dbInfo)` Adds a database info to the list of permitted databases
`KeepConfig`	`addOpenApiRoute(java.lang.String version, java.lang.String route)` Stores the HTTP route from the config for the relevant API version
`java.util.Collection<java.lang.String>`	`getAllActiveAppIds()`
`java.util.Collection<KeepApiInfo>`	`getAllKeepApiInfo(java.lang.String version)`
`java.util.Collection<KeepDbInfo>`	`getAllKeepDBInfo()`
`io.vertx.core.json.JsonArray`	`getApiNamesFromFilepath(java.lang.String filePath)` Returns a list of API Names a database is known with
`KeepApiInfo`	`getKeepApiInfo(java.lang.String operationName)` Retrieve an KeepApiInfo based on its eventBusId EventbusId is created from Tag and OperationId
`KeepApiInfo`	`getKeepApiInfo(java.lang.String version, java.lang.String operationName)` Retrieve an KeepApiInfo based on its operationName
`io.vertx.core.json.JsonObject`	`getKeepApiSchema(java.lang.String schemaName)` Returns the JSON Schema part of the OpenAPI specification with the given name.
`java.util.Collection<java.lang.String>`	`getKeepApiVersions()`
`KeepDbInfo`	`getKeepDbInfo(java.lang.String apiName)` Retrieves the database information for a given API Name
`KeepDbInfo`	`getKeepMailInfo(java.lang.String mailFileName)` Placeholder for MAIL files
`io.vertx.core.json.JsonObject`	`getOpenApiJson(java.lang.String version)`
`java.lang.String`	`getOpenApiRoute(java.lang.String version)`
`io.vertx.core.json.JsonObject`	`getPIMConfig()`
`java.lang.String`	`getSystemUserName()`
`boolean`	`isAllowDominoLogin()` Checks if login with username/password stored in Domino is permitted or only external IdP are accepted
`boolean`	`isAllowLocalUsers(boolean isServer)` are users defined in KeepConfig allowed?
`boolean`	`isValidAppId(java.lang.String appId)`
`void`	`removeActiveAppId(java.lang.String appId)`
`KeepConfig`	`setPimConfig(io.vertx.core.json.JsonObject pimConfig)`
`KeepConfig`	`setSystemUserName(java.lang.String userName)`
`static KeepConfigHolder`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static KeepConfigHolder[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hcl.domino.keep.config.KeepConfig
addConfigFromArray, addDbInfoFromJson

- Enum Constant Detail
  - INSTANCE
```
public static final KeepConfigHolder INSTANCE
```
    Singleton
- Method Detail
  - values
```
public static KeepConfigHolder[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (KeepConfigHolder c : KeepConfigHolder.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static KeepConfigHolder valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - addActiveAppId
```
public void addActiveAppId(java.lang.String appId)
```
    Specified by:
    
    addActiveAppId in interface KeepConfig
    
    Parameters:
    
    appId - adds the appId to the config cache
  - addKeepApiInfo
```
public KeepConfig addKeepApiInfo(java.lang.String version,
                                 KeepApiInfo apiInfo)
```
    Specified by:
    
    addKeepApiInfo in interface KeepConfig
    
    Parameters:
    
    version - API Version
    
    apiInfo - the apiInfoObject to add
    
    Returns:
    
    KeepConfig for fluent operation
  - addKeepApiInfoFromOpenApiJson
```
public KeepConfig addKeepApiInfoFromOpenApiJson(java.lang.String version,
                                                io.vertx.core.json.JsonObject source)
```
    Description copied from interface: KeepConfig
    
    Loads all API info objects from an openAPI 3.0 specification file in JSON format
    
    Specified by:
    
    addKeepApiInfoFromOpenApiJson in interface KeepConfig
    
    Parameters:
    
    version - API Version v1,v2 etc
    
    source - the JsonObject conforming to OpenAPI
    
    Returns:
    
    fluid the config
  - addKeepDbInfo
```
public KeepConfig addKeepDbInfo(java.lang.String apiName,
                                KeepDbInfo dbInfo)
```
    Description copied from interface: KeepConfig
    
    Adds a database info to the list of permitted databases
    Specified by:
    
    addKeepDbInfo in interface KeepConfig
    
    Parameters:
    apiName -
    
    the API name to be used
    dbInfo -
    
    the info object
    Returns:
    
    KeepConfig for fluent use
  - addOpenApiRoute
```
public KeepConfig addOpenApiRoute(java.lang.String version,
                                  java.lang.String route)
```
    Description copied from interface: KeepConfig
    
    Stores the HTTP route from the config for the relevant API version
    Specified by:
    
    addOpenApiRoute in interface KeepConfig
    
    Parameters:
    version -
    
    API version
    route -
    
    route for the version
    Returns:
    
    fluent
  - getAllActiveAppIds
```
public java.util.Collection<java.lang.String> getAllActiveAppIds()
```
    Specified by:
    
    getAllActiveAppIds in interface KeepConfig
    
    Returns:
    
    all active external application IDs
  - getAllKeepApiInfo
```
public java.util.Collection<KeepApiInfo> getAllKeepApiInfo(java.lang.String version)
```
    Specified by:
    
    getAllKeepApiInfo in interface KeepConfig
    
    Parameters:
    
    version - v1, v2 etc. to determine what api we load
    
    Returns:
    
    all KeepApiInfo object
  - getAllKeepDBInfo
```
public java.util.Collection<KeepDbInfo> getAllKeepDBInfo()
```
    Specified by:
    
    getAllKeepDBInfo in interface KeepConfig
    
    Returns:
    
    all loaded DBInfo objects
  - getApiNamesFromFilepath
```
public io.vertx.core.json.JsonArray getApiNamesFromFilepath(java.lang.String filePath)
```
    Description copied from interface: KeepConfig
    
    Returns a list of API Names a database is known with
    Specified by:
    
    getApiNamesFromFilepath in interface KeepConfig
    
    Parameters:
    filePath -
    
    the path including file name
    Returns:
    
    array of Names, might be empty
  - getKeepApiInfo
```
public KeepApiInfo getKeepApiInfo(java.lang.String operationName)
```
    Description copied from interface: KeepConfig
    
    Retrieve an KeepApiInfo based on its eventBusId EventbusId is created from Tag and OperationId
    
    Specified by:
    
    getKeepApiInfo in interface KeepConfig
    
    Returns:
    
    KeepAPIInfo with that name or null if not found
  - getKeepApiInfo
```
public KeepApiInfo getKeepApiInfo(java.lang.String version,
                                  java.lang.String operationName)
```
    Description copied from interface: KeepConfig
    
    Retrieve an KeepApiInfo based on its operationName
    
    Specified by:
    
    getKeepApiInfo in interface KeepConfig
    
    Parameters:
    
    version - API Version v1 v2
    
    Returns:
    
    KeepAPIInfo with that name or null if not found
  - getKeepApiSchema
```
public io.vertx.core.json.JsonObject getKeepApiSchema(java.lang.String schemaName)
```
    Description copied from interface: KeepConfig
    
    Returns the JSON Schema part of the OpenAPI specification with the given name. Last loaded wins
    Specified by:
    
    getKeepApiSchema in interface KeepConfig
    
    Parameters:
    schemaName -
    
    name of the schema from OpenAPI specification
    Returns:
    
    A JsonObject, might be empty if Schema name not found
  - getKeepApiVersions
```
public java.util.Collection<java.lang.String> getKeepApiVersions()
```
    Specified by:
    
    getKeepApiVersions in interface KeepConfig
    
    Returns:
    
    A list of all loaded API Versions
  - getKeepDbInfo
```
public KeepDbInfo getKeepDbInfo(java.lang.String apiName)
```
    Description copied from interface: KeepConfig
    
    Retrieves the database information for a given API Name
    Specified by:
    
    getKeepDbInfo in interface KeepConfig
    
    Parameters:
    apiName -
    
    the API Name
    Returns:
    
    the database info
  - getKeepMailInfo
```
public KeepDbInfo getKeepMailInfo(java.lang.String mailFileName)
```
    Placeholder for MAIL files
    
    Specified by:
    
    getKeepMailInfo in interface KeepConfig
    
    Parameters:
    
    mailFileName - The filePath to the actual mail
    
    Returns:
    
    a KeebDBInfo for MAIL
  - getOpenApiJson
```
public io.vertx.core.json.JsonObject getOpenApiJson(java.lang.String version)
```
    Specified by:
    
    getOpenApiJson in interface KeepConfig
    
    Parameters:
    
    version - v1, v2
    
    Returns:
    
    The OpenAPI specification as JsonObject
  - getOpenApiRoute
```
public java.lang.String getOpenApiRoute(java.lang.String version)
```
    Specified by:
    
    getOpenApiRoute in interface KeepConfig
    
    Parameters:
    
    version - API version
    
    Returns:
    
    route for the version
  - getPIMConfig
```
public io.vertx.core.json.JsonObject getPIMConfig()
```
    Specified by:
    
    getPIMConfig in interface KeepConfig
    
    Returns:
    
    The configuration object for PIM handling
  - getSystemUserName
```
public java.lang.String getSystemUserName()
```
    Specified by:
    
    getSystemUserName in interface KeepConfig
    
    Returns:
    
    The username associated with the ID file
  - isAllowDominoLogin
```
public boolean isAllowDominoLogin()
```
    Description copied from interface: KeepConfig
    
    Checks if login with username/password stored in Domino is permitted or only external IdP are accepted
    
    Specified by:
    
    isAllowDominoLogin in interface KeepConfig
    
    Returns:
    
    true (default) users can login
  - isAllowLocalUsers
```
public boolean isAllowLocalUsers(boolean isServer)
```
    Description copied from interface: KeepConfig
    
    are users defined in KeepConfig allowed?
    
    Specified by:
    
    isAllowLocalUsers in interface KeepConfig
    
    Parameters:
    
    isServer - is Keep running on a server
    
    Returns:
    
    true if allowed
  - isValidAppId
```
public boolean isValidAppId(java.lang.String appId)
```
    Specified by:
    
    isValidAppId in interface KeepConfig
    
    Parameters:
    
    appId - external application ID to check
    
    Returns:
    
    whether or not the passed appId is an active one
  - removeActiveAppId
```
public void removeActiveAppId(java.lang.String appId)
```
    Specified by:
    
    removeActiveAppId in interface KeepConfig
    
    Parameters:
    
    appId - removes the appId to the config cache
  - setPimConfig
```
public KeepConfig setPimConfig(@Nonnull
                               io.vertx.core.json.JsonObject pimConfig)
```
    Specified by:
    
    setPimConfig in interface KeepConfig
    
    Parameters:
    pimConfig -
    
    JsonObject with PIM configuration
    Returns:
    
    fluent
  - setSystemUserName
```
public KeepConfig setSystemUserName(java.lang.String userName)
```
    Specified by:
    
    setSystemUserName in interface KeepConfig
    
    Returns:
    
    fluent KeepConfig

Enum KeepConfigHolder

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.hcl.domino.keep.config.KeepConfig

Enum Constant Detail

INSTANCE

Method Detail

values

valueOf

addActiveAppId

addKeepApiInfo

addKeepApiInfoFromOpenApiJson

addKeepDbInfo

addOpenApiRoute

getAllActiveAppIds

getAllKeepApiInfo

getAllKeepDBInfo

getApiNamesFromFilepath

getKeepApiInfo

getKeepApiInfo

getKeepApiSchema

getKeepApiVersions

getKeepDbInfo

getKeepMailInfo

getOpenApiJson

getOpenApiRoute

getPIMConfig

getSystemUserName

isAllowDominoLogin

isAllowLocalUsers

isValidAppId

removeActiveAppId

setPimConfig

setSystemUserName