ConnectionParams class

Contains connection parameters to connect to external services. They are used together with credential parameters, but usually stored separately from more protected sensitive values.

Configuration parameters

discovery_key: key to retrieve parameters from discovery service
protocol: connection protocol like http, https, tcp, udp
host: host name or IP address
port: port number
uri: resource URI or connection string with all parameters in it

In addition to standard parameters ConnectionParams may contain any number of custom parameters

See ConfigParams See CredentialParams See ConnectionResolver See IDiscovery

Example

Example ConnectionParams object usage:

var connection = ConnectionParams.fromTuples([
    'protocol', 'http',
    'host', '10.1.1.100',
    'port', '8080',
    'cluster', 'mycluster'
]);

var host = connection.getHost();                             // Result: '10.1.1.100'
var port = connection.getPort();                             // Result: 8080
var cluster = connection.getAsNullableString('cluster');     // Result: 'mycluster'

Inheritance

Constructors

ConnectionParams([dynamic values]): Creates a new connection parameters and fills it with values.

Properties

entries → Iterable<MapEntry<String, String?>>: The map entries of this.
read-onlyinherited
hashCode → int: The hash code for this object.
read-onlyinherited
isEmpty → bool: Whether there is no key/value pair in the map.
read-onlyinherited
isNotEmpty → bool: Whether there is at least one key/value pair in the map.
read-onlyinherited
keys → Iterable<String>: The keys of this.
read-onlyinherited
length → int: The number of key/value pairs in the map.
read-onlyinherited
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited
values → Iterable<String?>: The values of this.
read-onlyinherited

Methods

addAll(Map<String, String?> other) → void: Adds all key/value pairs of other to this map.
inherited
addEntries(Iterable<MapEntry<String, String?>> newEntries) → void: Adds all key/value pairs of newEntries to this map.
inherited
addSection(String? section, ConfigParams? sectionParams) → void: Adds parameters into this ConfigParams under specified section. Keys for the new parameters are appended with section dot prefix.
inherited
append(dynamic map) → void: Appends new elements to this map.
inherited
cast<RK, RV>() → Map<RK, RV>: Provides a view of this map as having RK keys and RV instances, if necessary.
inherited
clear() → void: Clears this map by removing all its elements.
inherited
clone() → dynamic: Creates a binary clone of this object.
inherited
containsKey(Object? key) → bool: Whether this map contains the given key.
inherited
containsValue(Object? value) → bool: Whether this map contains the given value.
inherited
forEach(void action(String key, String? value)) → void: Applies action to each key/value pair of the map.
inherited
fromJson(Map<String, dynamic> json) → void: Returned JSON Map object from values of this object
inherited
get(String key) → String?: Gets a map element specified by its key.
inherited
getAsArray(String key) → AnyValueArray: Converts map element into an AnyValueArray or returns empty AnyValueArray if conversion is not possible.
inherited
getAsArrayWithDefault(String key, AnyValueArray defaultValue) → AnyValueArray: Converts map element into an AnyValueArray or returns default value if conversion is not possible.
inherited
getAsBoolean(String key) → bool: Converts map element into a boolean or returns false if conversion is not possible.
inherited
getAsBooleanWithDefault(String key, bool defaultValue) → bool: Converts map element into a boolean or returns default value if conversion is not possible.
inherited
getAsDateTime(String key) → DateTime: Converts map element into a DateTime or returns the current date if conversion is not possible.
inherited
getAsDateTimeWithDefault(String key, DateTime defaultValue) → DateTime: Converts map element into a DateTime or returns default value if conversion is not possible.
inherited
getAsDouble(String key) → double: Converts map element into a double or returns 0 if conversion is not possible.
inherited
getAsDoubleWithDefault(String key, double defaultValue) → double: Converts map element into a double or returns default value if conversion is not possible.
inherited
getAsDuration(String key) → Duration: Converts map element into a Duration or returns the current date if conversion is not possible.
inherited
getAsDurationWithDefault(String key, Duration defaultValue) → Duration: Converts map element into a Duration or returns default value if conversion is not possible.
inherited
getAsFloat(String key) → double: Converts map element into a float or returns 0 if conversion is not possible.
inherited
getAsFloatWithDefault(String key, double defaultValue) → double: Converts map element into a flot or returns default value if conversion is not possible.
inherited
getAsInteger(String key) → int: Converts map element into an integer or returns 0 if conversion is not possible.
inherited
getAsIntegerWithDefault(String key, int defaultValue) → int: Converts map element into an integer or returns default value if conversion is not possible.
inherited
getAsLong(String key) → int: Converts map element into a long or returns 0 if conversion is not possible.
inherited
getAsLongWithDefault(String key, int defaultValue) → int: Converts map element into a long or returns default value if conversion is not possible.
inherited
getAsMap(String key) → AnyValueMap: Converts map element into an AnyValueMap or returns empty AnyValueMap if conversion is not possible.
inherited
getAsMapWithDefault(String key, AnyValueMap defaultValue) → AnyValueMap: Converts map element into an AnyValueMap or returns default value if conversion is not possible.
inherited
getAsNullableArray(String key) → AnyValueArray?: Converts map element into an AnyValueArray or returns null if conversion is not possible.
inherited
getAsNullableBoolean(String key) → bool?: Converts map element into a boolean or returns null if conversion is not possible.
inherited
getAsNullableDateTime(String key) → DateTime?: Converts map element into a DateTime or returns null if conversion is not possible.
inherited
getAsNullableDouble(String key) → double?: Converts map element into a double or returns null if conversion is not possible.
inherited
getAsNullableDuration(String key) → Duration?: Converts map element into a Duration or returns null if conversion is not possible.
inherited
getAsNullableFloat(String key) → double?: Converts map element into a float or returns null if conversion is not possible.
inherited
getAsNullableInteger(String key) → int?: Converts map element into an integer or returns null if conversion is not possible.
inherited
getAsNullableLong(String key) → int?: Converts map element into a long or returns null if conversion is not possible.
inherited
getAsNullableMap(String key) → AnyValueMap?: Converts map element into an AnyValueMap or returns null if conversion is not possible.
inherited
getAsNullableString(String key) → String?: Converts map element into a string or returns null if conversion is not possible.
inherited
getAsNullableType<T>(TypeCode type, String key) → T?: Converts map element into a value defined by specied typecode. If conversion is not possible it returns null.
inherited
getAsObject([String? key]) → dynamic: Gets the value stored in map element without any conversions. When element key is not defined it returns the entire map value.
inherited
getAsString(dynamic key) → String: Converts map element into a string or returns '' if conversion is not possible.
inherited
getAsStringWithDefault(String key, String defaultValue) → String: Converts map element into a string or returns default value if conversion is not possible.
inherited
getAsType<T>(TypeCode type, String key) → T?: Converts map element into a value defined by specied typecode. If conversion is not possible it returns default value for the specified type.
inherited
getAsTypeWithDefault<T>(TypeCode type, String key, T defaultValue) → T: Converts map element into a value defined by specied typecode. If conversion is not possible it returns default value.
inherited
getAsValue(String key) → AnyValue: Converts map element into an AnyValue or returns an empty AnyValue if conversion is not possible.
inherited
getDiscoveryKey() → String?: Gets the key to retrieve this connection from DiscoveryService. If this key is null, than all parameters are already present.
getHost() → String?: Gets the host name or IP address.
getKeys() → List<String>: Gets keys of all elements stored in this map.
inherited
getPort() → int?: Gets the port number.
getPortWithDefault(int defaultPort) → int: Gets the port number with default value.
getProtocol([String? defaultValue]) → String?: Gets the connection protocol.
getProtocolWithDefault(String defaultValue) → String: Gets the connection protocol with default value.
getSection(String section) → ConfigParams: Gets parameters from specific section stored in this ConfigMap. The section name is removed from parameter keys.
inherited
getSectionNames() → List<String>: Gets a list with all 1st level section names.
inherited
getUri() → String?: Gets the resource URI or connection string. Usually it includes all connection parameters in it.
getValue() → Map<String, String?>: Gets an map with values.
inherited
innerValue() → dynamic: Returned inner values in Map object
inherited
map<K2, V2>(MapEntry<K2, V2> transform(String key, String? value)) → Map<K2, V2>: Returns a new map where all entries of this map are transformed by the given convert function.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
override(ConfigParams configParams) → ConfigParams: Overrides parameters with new values from specified ConfigParams and returns a new ConfigParams object.
inherited
put(String key, dynamic value) → void: Puts a new value into map element specified by its key.
inherited
putIfAbsent(String key, String? ifAbsent()) → String?: Look up the value of key, or add a new entry if it isn't there.
inherited
remove(Object? key) → String?: Removes key and its associated value, if present, from the map.
inherited
removeWhere(bool test(String key, String? value)) → void: Removes all entries of this map that satisfy the given test.
inherited
setAsObject(dynamic key, [dynamic value]) → void: Sets a new value to map element specified by its index. When the index is not defined, it resets the entire map value. This method has double purpose because method overrides are not supported in JavaScript.
inherited
setDefaults(ConfigParams defaultConfigParams) → ConfigParams: Set default values from specified ConfigParams and returns a new ConfigParams object.
inherited
setDiscoveryKey(String? value) → void: Sets the key to retrieve these parameters from DiscoveryService.
setHost(String? value) → void: Sets the host name or IP address.
setPort(int value) → void: Sets the port number.
setProtocol(String? value) → void: Sets the connection protocol.
setUri(String value) → void: Sets the resource URI or connection string.
toJson() → Map<String, dynamic>: Initialize this object from JSON Map object
inherited
toString() → String: Gets a string representation of the object. The result is a semicolon-separated list of key-value pairs as 'key1=value1;key2=value2;key=value3'
inherited
update(String key, String? update(String? value), {String? ifAbsent()?}) → String?: Updates the value for the provided key.
inherited
updateAll(String? update(String key, String? value)) → void: Updates all values.
inherited
useDiscovery() → bool: Checks if these connection parameters shall be retrieved from DiscoveryService. The connection parameters are redirected to DiscoveryService when discovery_key parameter is set.

Operators

operator ==(Object other) → bool: The equality operator.
inherited
operator [](Object? key) → String?: The value for the given key, or null if key is not in the map.
inherited
operator []=(String key, String? value) → void: Associates the key with the given value.
inherited

Static Methods

fromConfig(ConfigParams config) → ConnectionParams?: Retrieves a single ConnectionParams from configuration parameters from 'connection' section. If 'connections' section is present instead, then is returns only the first connection element.
fromString(String line) → ConnectionParams: Creates a new ConnectionParams object filled with key-value pairs serialized as a string.
override
fromTuples(List tuples) → ConnectionParams: Creates a new ConnectionParams object filled with provided key-value pairs called tuples. Tuples parameters contain a sequence of key1, value1, key2, value2, ... pairs.
override
manyFromConfig(ConfigParams config) → List<ConnectionParams>: Retrieves all ConnectionParams from configuration parameters from 'connections' section. If 'connection' section is present instead, than it returns a list with only one ConnectionParams.