KeepConfig

All Known Implementing Classes:

KeepConfigHolder
```
public interface KeepConfig
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addActiveAppId(java.lang.String appId)`
`default KeepConfig`	`addConfigFromArray(io.vertx.core.json.JsonArray source, boolean supressEmptyFieldWarning)` Convenience method to load multiple configurations from
`default KeepConfig`	`addDbInfoFromJson(io.vertx.core.json.JsonObject source, boolean supressEmptyFieldWarning)` Convenience method to add a KeepConfig from a JSON file
`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 eventBusId)` 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)`
`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)`

- Method Detail
  - addActiveAppId
```
void addActiveAppId(java.lang.String appId)
```
    Parameters:
    
    appId - adds the appId to the config cache
  - addConfigFromArray
```
default KeepConfig addConfigFromArray(io.vertx.core.json.JsonArray source,
                                      boolean supressEmptyFieldWarning)
```
    Convenience method to load multiple configurations from
    Parameters:
    
    source -
    supressEmptyFieldWarning -
    
    should the stern warning about empty fields be suppressed
    Returns:
    
    the loaded config
  - addDbInfoFromJson
```
default KeepConfig addDbInfoFromJson(io.vertx.core.json.JsonObject source,
                                     boolean supressEmptyFieldWarning)
```
    Convenience method to add a KeepConfig from a JSON file
    Parameters:
    
    source - JsonObject with configuration info
    supressEmptyFieldWarning -
    
    should the stern warning about empty fields be suppressed
    Returns:
    
    fluent KeepConfig
  - addKeepApiInfo
```
KeepConfig addKeepApiInfo(java.lang.String version,
                          KeepApiInfo apiInfo)
```
    Parameters:
    
    version - API Version
    
    apiInfo - the apiInfoObject to add
    
    Returns:
    
    KeepConfig for fluent operation
  - addKeepApiInfoFromOpenApiJson
```
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
    
    Parameters:
    
    version - API Version v1,v2 etc
    
    source - the JsonObject conforming to OpenAPI
    
    Returns:
    
    fluid the config
  - addKeepDbInfo
```
KeepConfig addKeepDbInfo(java.lang.String apiName,
                         KeepDbInfo dbInfo)
```
    Adds a database info to the list of permitted databases
    Parameters:
    apiName -
    
    the API name to be used
    dbInfo -
    
    the info object
    Returns:
    
    KeepConfig for fluent use
  - addOpenApiRoute
```
KeepConfig addOpenApiRoute(java.lang.String version,
                           java.lang.String route)
```
    Stores the HTTP route from the config for the relevant API version
    Parameters:
    version -
    
    API version
    route -
    
    route for the version
    Returns:
    
    fluent
  - getAllActiveAppIds
```
java.util.Collection<java.lang.String> getAllActiveAppIds()
```
    Returns:
    
    all active external application IDs
  - getAllKeepApiInfo
```
java.util.Collection<KeepApiInfo> getAllKeepApiInfo(java.lang.String version)
```
    Parameters:
    
    version - v1, v2 etc. to determine what api we load
    
    Returns:
    
    all KeepApiInfo object
  - getAllKeepDBInfo
```
java.util.Collection<KeepDbInfo> getAllKeepDBInfo()
```
    Returns:
    
    all loaded DBInfo objects
  - getApiNamesFromFilepath
```
io.vertx.core.json.JsonArray getApiNamesFromFilepath(java.lang.String filePath)
```
    Returns a list of API Names a database is known with
    Parameters:
    filePath -
    
    the path including file name
    Returns:
    
    array of Names, might be empty
  - getKeepApiInfo
```
KeepApiInfo getKeepApiInfo(java.lang.String eventBusId)
```
    Retrieve an KeepApiInfo based on its eventBusId EventbusId is created from Tag and OperationId
    
    Parameters:
    
    eventBusId -
    
    Returns:
    
    KeepAPIInfo with that name or null if not found
  - getKeepApiInfo
```
KeepApiInfo getKeepApiInfo(java.lang.String version,
                           java.lang.String operationName)
```
    Retrieve an KeepApiInfo based on its operationName
    
    Parameters:
    
    version - API Version v1 v2
    
    operationName -
    
    Returns:
    
    KeepAPIInfo with that name or null if not found
  - getKeepApiSchema
```
io.vertx.core.json.JsonObject getKeepApiSchema(java.lang.String schemaName)
```
    Returns the JSON Schema part of the OpenAPI specification with the given name. Last loaded wins
    Parameters:
    schemaName -
    
    name of the schema from OpenAPI specification
    Returns:
    
    A JsonObject, might be empty if Schema name not found
  - getKeepApiVersions
```
java.util.Collection<java.lang.String> getKeepApiVersions()
```
    Returns:
    
    A list of all loaded API Versions
  - getKeepDbInfo
```
KeepDbInfo getKeepDbInfo(java.lang.String apiName)
```
    Retrieves the database information for a given API Name
    Parameters:
    apiName -
    
    the API Name
    Returns:
    
    the database info
  - getKeepMailInfo
```
KeepDbInfo getKeepMailInfo(java.lang.String mailFileName)
```
    Parameters:
    
    mailFileName - The filePath to the actual mail
    
    Returns:
    
    a KeebDBInfo for MAIL
  - getOpenApiJson
```
io.vertx.core.json.JsonObject getOpenApiJson(java.lang.String version)
```
    Parameters:
    
    version - v1, v2
    
    Returns:
    
    The OpenAPI specification as JsonObject
  - getOpenApiRoute
```
java.lang.String getOpenApiRoute(java.lang.String version)
```
    Parameters:
    
    version - API version
    
    Returns:
    
    route for the version
  - getPIMConfig
```
io.vertx.core.json.JsonObject getPIMConfig()
```
    Returns:
    
    The configuration object for PIM handling
  - getSystemUserName
```
java.lang.String getSystemUserName()
```
    Returns:
    
    The username associated with the ID file
  - isAllowDominoLogin
```
boolean isAllowDominoLogin()
```
    Checks if login with username/password stored in Domino is permitted or only external IdP are accepted
    
    Returns:
    
    true (default) users can login
  - isAllowLocalUsers
```
boolean isAllowLocalUsers(boolean isServer)
```
    are users defined in KeepConfig allowed?
    
    Parameters:
    
    isServer - is Keep running on a server
    
    Returns:
    
    true if allowed
  - isValidAppId
```
boolean isValidAppId(java.lang.String appId)
```
    Parameters:
    
    appId - external application ID to check
    
    Returns:
    
    whether or not the passed appId is an active one
  - removeActiveAppId
```
void removeActiveAppId(java.lang.String appId)
```
    Parameters:
    
    appId - removes the appId to the config cache
  - setPimConfig
```
KeepConfig setPimConfig(io.vertx.core.json.JsonObject pimConfig)
```
    Parameters:
    pimConfig -
    
    JsonObject with PIM configuration
    Returns:
    
    fluent
  - setSystemUserName
```
KeepConfig setSystemUserName(java.lang.String userName)
```
    Parameters:
    
    userName -
    
    Returns:
    
    fluent KeepConfig

Interface KeepConfig

Method Summary

Method Detail

addActiveAppId

addConfigFromArray

addDbInfoFromJson

addKeepApiInfo

addKeepApiInfoFromOpenApiJson

addKeepDbInfo

addOpenApiRoute

getAllActiveAppIds

getAllKeepApiInfo

getAllKeepDBInfo

getApiNamesFromFilepath

getKeepApiInfo

getKeepApiInfo

getKeepApiSchema

getKeepApiVersions

getKeepDbInfo

getKeepMailInfo

getOpenApiJson

getOpenApiRoute

getPIMConfig

getSystemUserName

isAllowDominoLogin

isAllowLocalUsers

isValidAppId

removeActiveAppId

setPimConfig

setSystemUserName