BaseContext#

class cegalprizm.hub.BaseContext(hub_client: cegalprizm.hub.client.HubClient, wellknown_connector_id: str, connector_filter: Optional[cegalprizm.hub.connector_filter.ConnectorFilter] = None)#

A Base Context typically extended by another class which will contain some utility methods to communicate with a specific Connector type

Create a BaseContext from the specified parameters

Parameters
  • hub_client (HubClient) – The HubClient which makes client requests to Cegal Hub Server.

  • wellknown_connector_id (str) – the wellknown string that represents the Connector type. i.e cegal.hub.agentor cegal.hub.petrel

  • connector_filter – the filter for targeting a specific instance or instances of a Connector type. Defaults to None.

property available#

Get the available Cegal Hub Connectors

Raises

Exception – If there was a problem obtaining the available Cegal Hub Connectors

Returns

An enumeration of objects for available Connectors

Return type

Connector[]

property connection_parameters#

Get a deep copy of the ConnectionParameters corresponding to the running Cegal Hub Server

Returns

The ConnectionParameters object.

Return type

ConnectionParameters

property connector_filter#

Get the ConnectorFilter associated with the context.

Returns

The ConnectorFilter object.

Return type

ConnectorFilter