HttpConnectionResolver

Helper class to retrieve connections for HTTP-based services and clients.

Implements: IReferenceable, IConfigurable

Description

The HttpConnectionResolver class is used to retrieve connections for HTTP-based services and clients.

Important points

  • In addition to its regular functions, ConnectionResolver is able to parse http:// URIs and validate connection parameters before returning them.

Configuration parameters

  • connection:
    • discovery_key: (optional) key to retrieve the connection from IDiscovery
    • … : other connection parameters
  • connections: alternative to connection
    • [connection params 1]: first connection parameters
    • …
    • [connection params N]: Nth connection parameters
    • …

References

  • *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve a connection

Fields

_connection_resolver

Creates a connection resolver.

_connection_resolver: ConnectionResolver = ConnectionResolver()

_credential_resolver

The base credential resolver.

_credential_resolver: CredentialResolver = CredentialResolver()

Instance methods

configure

Configures component by passing configuration parameters.

configure(config: ConfigParams)

  • config: ConfigParams - configuration parameters to be set.

register

Registers the given connection in all referenced discovery services. This method can be used for dynamic service discovery.

register(correlation_id: Optional[str])

  • correlation_id: Optional[str] - (optional) transaction id used to trace execution through the call chain.

resolve

Resolves a single component connection. If the connections are configured to be retrieved from Discovery service, it finds a IDiscovery and resolves the connection there.

resolve(correlation_id: Optional[str]): ConfigParams

  • correlation_id: Optional[str] - (optional) transaction id used to trace execution through the call chain.
  • returns: ConfigParams - resolved connection.

resolve_all

Resolves all component connections. If connections are configured to be retrieved from Discovery service it finds a IDiscovery and resolves the connection there.

resolve_all(correlation_id: Optional[str]): ConfigParams

  • correlation_id: Optional[str] - (optional) transaction id used to trace execution through the call chain.
  • returns: ConfigParams - resolved connections.

set_references

Sets references to dependent components.

set_references(references: IReferences)

  • references: IReferences - references to locate the component dependencies.

Examples

config = ConfigParams.from_tuples("connection.host", "10.1.1.100","connection.port", 8080)
connectionResolver = HttpConnectionResolver()
connectionResolver.configure(config)
connectionResolver.set_references(references)
params = connectionResolver.resolve("123")

See also