Package com.predic8.membrane.core.interceptor.apikey.stores

Class ApiKeyFileStore

java.lang.Object

com.predic8.membrane.core.interceptor.apikey.stores.ApiKeyFileStore

All Implemented Interfaces:

ApiKeyStore

public class ApiKeyFileStore
extends Object
implements ApiKeyStore

Description

Loads api keys from a file. File has to be one key per line, blank lines for formatting are allowed. Optionally, a comma separated list of scopes after the key and a colon in between the two. Hash symbol can be used for comments at the end of each line, including empty lines.

Example

See: https://github.com/membrane/api-gateway/blob/master/distribution/examples/security/api-key/simple/demo-keys.txt

Constructor Summary

Constructors

Constructor	Description
ApiKeyFileStore()

Method Summary

Modifier and Type	Method	Description
String	getLocation()
Optional<List<String>>	getScopes(String key)
void	init(Router router)
static Map<String,Optional<List<String>>>	readKeyData(Stream<String> lines)
void	setLocation(String location)

Methods inherited from class java.lang.Object

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

Constructor Details

ApiKeyFileStore

public ApiKeyFileStore()

Method Details

init

public void init(Router router)

Specified by:

init in interface ApiKeyStore

readKeyData

public static Map<String,Optional<List<String>>> readKeyData(Stream<String> lines)
                                                      throws IOException

Throws:

IOException

getScopes

public Optional<List<String>> getScopes(String key)
                                 throws UnauthorizedApiKeyException

Specified by:

getScopes in interface ApiKeyStore

Throws:

UnauthorizedApiKeyException

setLocation

public void setLocation(String location)

Description

Path/URL to the api key file.

getLocation

public String getLocation()