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.

close(correlation_id: Optional[str])

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

configure

Configures this HttpEndpoint using the given configuration parameters.

configure(config: ConfigParams)

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

get_correlation_id

Returns correlationId from request

get_correlation_id(): Optional[str]

returns: Optional[str] - http response to the request.

is_open

Checks if the component is open.

is_open(): bool

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

register

Registers a registerable object for dynamic endpoint discovery.

register(registration: IRegisterable)

registration: IRegisterable - the registration to add.

register_interceptor

Registers a middleware action for the given route.

register_interceptor(route: str, action: Callable)

route: str - route to register in this object’s REST server (service).
action: Callable - middleware action to perform at the given route.

register_route

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

register_route(method: str, route: str, schema: Schema, handler: Callable)

method: str - HTTP method of the route.
route: str - route to register in this object’s REST server (service).
schema: Schema - schema to use for parameter validation.
handler: Callable - action to perform at the given route.

register_route_with_auth

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

register_route_with_auth(method: str, route: str, schema: Schema, authorize: Callable, action: Callable)

method: str - HTTP method of the route.
route: str - route to register in this object’s REST server (service).
schema: Schema - schema to use for parameter validation.
authorize: Callable - authorization interceptor
action: Callable - action to perform at the given route.

set_references

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

set_references(references: IReferences)

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.

unregister(registration: IRegisterable)

registration: IRegisterable - registration to remove.

Examples

def my_method(_config, _references):
    endpoint = HttpEndpoint()
    if (_config)
        endpoint.configure(_config)
    if (_references)
        endpoint.setReferences(_references)
    # ...

    endpoint.open(correlationId)
    # ...