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

_connectionResolver

Creates a connection resolver.

protected _credentialResolver: ConnectionResolver = ConnectionResolver()

_credential_resolver

The base credential resolver.

protected _credentialResolver: CredentialResolver = CredentialResolver()

Instance methods

configure

Configures component by passing configuration parameters.

public configure(config: ConfigParams): void

  • 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.

public register(correlationId: string): void

  • correlationId: string - (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.

public resolve(correlationId: string): Promise<ConfigParams>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • returns: Promise<ConfigParams> - resolved connection.

resolveAll

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

resolveAll(correlationId: string): Promise<ConfigParams>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • returns: Promise<ConfigParams> - resolved connections.

setReferences

Sets references to dependent components.

public setReferences(references: IReferences): void

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

Examples

let config = ConfigParams.fromTuples(
     "connection.host", "10.1.1.100",
     "connection.port", 8080
);

let connectionResolver = new HttpConnectionResolver();

connectionResolver.configure(config);
connectionResolver.setReferences(references);

let connection = await connectionResolver.resolve("123");
// Now use connection...

See also