CredentialParams

Contains credentials to authenticate against external services.

Extends: ConfigParams

Description

The CredentialParams class allows you to create credential parameters that can be used to authenticate against external services.

Important points

  • Credential parameters are used together with connection parameters, but usually stored in a separate store, protected from unauthorized access.

Configuration parameters

  • store_key: key to retrieve parameters from credential store
  • username: user name
  • user: alternative to username
  • password: user password
  • pass: alternative to password
  • access_id: application access id
  • client_id: alternative to access_id
  • access_key: application secret key
  • client_key: alternative to access_key
  • secret_key: alternative to access_key

In addition to standard parameters CredentialParams may contain any number of custom parameters.

Constructors

Creates a new credential parameters and fills it with values.

CredentialParams([dynamic values])

  • values: dynamic - (optional) object to be converted into key-value pairs to initialize these credentials.

Instance methods

getAccessId

Gets the application’s access id. The value can be stored in parameters “access_id” or “client_id”.

String? getAccessId()

  • returns: String? - application’s access id.

getAccessKey

Gets the application’s secret key. The value can be stored in parameters “access_key”, “client_key” or “secret_key”.

String? getAccessKey()

  • returns: String? - application’s secret key.

getPassword

Get the user’s password. The value can be stored in parameters “password” or “pass”.

String? getPassword()

  • returns: String? - the user password.

getStoreKey

Gets the key to retrieve these credentials from ICredentialStore. If this key is null, then all parameters are already present.

String? getStoreKey()

  • returns: String? - the store key to retrieve credentials.

getUsername

Gets the username. The value can be stored in parameters “username” or “user”.

String? getUsername()

  • returns: String? - username.

setAccessId

Sets the application’s access id.

void setAccessId(String value)

  • value: String - new application’s access id.

setAccessKey

Sets the application’s secret key.

void setAccessKey(String? value)

  • value: String? - new application’s secret key.

setPassword

Sets the user’s password.

void setPassword(String? value)

  • password: String? - new user’s password.

setStoreKey

Sets the key to retrieve these parameters from ICredentialStore.

void setStoreKey(String? value)

  • value: String? - new key to retrieve credentials.

setUsername

Sets the username.

void setUsername(String? value)

  • value: String? - new username.

useCredentialStore

Checks if these credential parameters shall be retrieved from ICredentialStore. The credential parameters are redirected to ICredentialStore when store_key parameter is set.

bool useCredentialStore()

Static methods

fromConfig

Retrieves a single CredentialParams from configuration parameters from “credential” section. If the “credentials” section is present instead, then it returns only the first credential element.

static CredentialParams? fromConfig(ConfigParams config)

fromString

Creates a new CredentialParams object filled with key-value pairs serialized as a string.

static CredentialParams fromString(String line)

  • line: String - string with serialized key-value pairs as “key1=value1;key2=value2;…" Example: “Key1=123;Key2=ABC;Key3=2016-09-16T00:00:00.00Z”
  • returns: CredentialParams - new CredentialParams object.

fromTuples

Creates a new CredentialParams object filled with provided key-value pairs called tuples. Tuples parameters contain a sequence of key1, value1, key2, value2, … pairs.

static CredentialParams fromTuples(List<dynamic> tuples)

  • tuples: List<dynamic> - tuples to fill a new CredentialParams object.
  • returns: CredentialParams - new CredentialParams object.

manyFromConfig

Retrieves all CredentialParams from configuration parameters from “credentials” section. If “credential” section is present instead, then it returns a list with only one CredentialParams.

static List<CredentialParams> manyFromConfig(ConfigParams config)

  • config: ConfigParams - configuration parameters to retrieve credentials
  • returns: List<CredentialParams> - list of retrieved CredentialParams

Examples

var credential = CredentialParams.fromTuples(
    'user', 'jdoe',
    'pass', 'pass123',
    'pin', '321'
);

var username = credential.getUsername();             // Result: 'jdoe'
var password = credential.getPassword();             // Result: 'pass123'
var pin = credential.getAsNullableString('pin');     // Result: 321

See also