HttpEndpoint

Used for creating HTTP endpoints.

Implements: IConfigurable, IReferenceable, IOpenable

Description

The HttpEndpoint class allows you to create HTTP endpoints.

Important points

An endpoint is a URL, at which a given service can be accessed by a client.

Configuration parameters

Parameters to pass to the configure method for component configuration:

connection(s): the connection resolver’s connections:
- “connection.discovery_key”: key to use for connection resolving in a discovery service;
- “connection.protocol”: connection’s protocol;
- “connection.host”: target host;
- “connection.port”: target port;
- “connection.uri”: target URI.
credential: the HTTPS credentials:
- “credential.ssl_key_file”: SSL private key in PEM
- “credential.ssl_crt_file”: SSL certificate in PEM
- “credential.ssl_ca_file”: certificate authorities (root cerfiticates) in PEM

References

A logger, counters, and a connection resolver can be referenced by passing the following references to the object’s set_references method:

*:logger:*:*:1.0 - (optional) ILogger components to pass log messages
*:counters:*:*:1.0 - (optional) ICounters components to pass collected measurements
*:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connections

Instance methods

close

Closes this endpoint and the REST server (service) that was opened earlier.

public close(context: IContext): Promise<void>

context: IContext - (optional) a context to trace execution through a call chain.

configure

Configures this HttpEndpoint using the given configuration parameters.

public configure(config: ConfigParams): void

config: ConfigParams - configuration parameters, containing a “connection(s)” section.

getTraceId

Returns traceId from request

public getTraceId(): string

returns: string - http response to the request.

isOpen

Checks if the component is open.

public isOpen(): boolean

returns: boolean - whether or not this endpoint is open with an actively listening REST server.

register

Registers a registerable object for dynamic endpoint discovery.

public register(registration: IRegisterable): void

registration: IRegisterable - the registration to add.

registerInterceptor

Registers a middleware action for the given route.

public registerInterceptor(route: string, action: (req: any, res: any, next: () => void) => void): void

route: string - route to register in this object’s REST server (service).
action: (req: any, res: any, next: () => void) => void - middleware action to perform at the given route.

registerRoute

Registers an action in this objects REST server (service) by the given method and route.

public registerRoute(method: string, route: string, schema: Schema, action: (req: any, res: any) => void): void

method: string - HTTP method of the route.
route: string - route to register in this object’s REST server (service).
schema: Schema - schema to use for parameter validation.
action: (req: any, res: any) => void - action to perform at the given route.

registerRouteWithAuth

Registers an action with authorization in this objects REST server (service) by the given method and route.

public registerRouteWithAuth(method: string, route: string, schema: Schema, authorize: (req: any, res: any, next: () => void) => void, action: (req: any, res: any) => void): void

method: string - HTTP method of the route.
route: string - route to register in this object’s REST server (service).
schema: Schema - schema to use for parameter validation.
authorize: (req: any, res: any, next: () => void) => void - authorization interceptor
action: (req: any, res: any) => void - action to perform at the given route.

setReferences

Sets references to this endpoint’s logger, counters, and connection resolver.

public setReferences(references: IReferences): void

references: IReferences - IReferences object, containing references to a logger, counters, and a connection resolver.

unregister

Unregisters a registerable object, so that it is no longer used in dynamic endpoint discovery.

public unregister(registration: IReferences): void

registration: IRegisterable - registration to remove.

Examples

public async MyMethod(config: ConfigParams, references: IReferences): Promise<void> {
    let endpoint = new HttpEndpoint();
    if (this._config)
        endpoint.configure(this._config);
    if (this._references)
        endpoint.setReferences(this._references);
    ...
    await this._endpoint.open(context);
    this._opened = true;
    ...
}