Package org.pipservices3.components.auth

Interface ICredentialStore

All Known Implementing Classes:

MemoryCredentialStore

public interface ICredentialStore

Interface for credential stores which are used to store and lookup credentials to authenticate against external services.

See Also:

CredentialParams, ConnectionParams

Method Summary

Modifier and Type	Method	Description
CredentialParams	lookup(String correlationId, String key)	Lookups credential parameters by its key.
void	store(String correlationId, String key, CredentialParams credential)	Stores credential parameters into the store.

Method Details

store

void store(String correlationId,
String key,
CredentialParams credential)

Stores credential parameters into the store.

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

key - a key to uniquely identify the credential.

credential - a credential to be stored.

lookup

CredentialParams lookup(String correlationId,
String key)

Lookups credential parameters by its key.

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

key - a key to uniquely identify the credential.

Returns:

found credential parameters or null if nothing was found