pip_services3_commons.run.Opener module

pip_services3_commons.run.Opener

Opener component implementation

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_commons.run.Opener.Opener

Bases: object

Helper class that opens components.

static is_opened(components: List[Any])bool

Checks if all components are opened.

To be checked components must implement IOpenable interface. If they don’t the call to this method returns true.

Parameters

components – a list of components that are to be checked.

Returns

true if all components are opened and false if at least one component is closed.

static is_opened_one(component: Any)bool

Checks if specified component is opened.

To be checked components must implement IOpenable interface. If they don’t the call to this method returns true.

Parameters

component – the component that is to be checked.

Returns

true if component is opened and false otherwise.

static open(correlation_id: Optional[str, None], components: List[Any])

Opens multiple components.

To be opened components must implement IOpenable interface. If they don’t the call to this method has no effect.

Parameters
  • correlation_id – (optional) transaction id to trace execution through call chain.

  • components – the list of components that are to be closed.

static open_one(correlation_id: Optional[str, None], component: Any)

Opens specific component.

To be opened components must implement IOpenable interface. If they don’t the call to this method has no effect.

Parameters
  • correlation_id – (optional) transaction id to trace execution through call chain.

  • component – the component that is to be opened.