Managed references that in addition to keeping and locating references can also manage their lifecycle.
Implements: ReferencesDecorator, IOpenable
Description
The ManagedReferences class allows you to create managed references that in additon to keeping and locating references can also manage their lifecycle, such as:
- Auto-creation of missing components using available factories
- Auto-linking newly added components
- Auto-opening newly added components
- Auto-closing removed components
Constructors
Creates a new instance of the decorator.
ManagedReferences(tuples: Sequence[Any] = None)
- tuples: Sequence[Any] - tuples where odd values are component locators (descriptors) and even values are component references
Fields
Instance methods
close
Closes the component and frees used resources.
close(correlation_id: Optional[str])
- correlation_id: Optional[str] - (optional) transaction id used to trace execution through the call chain.
is_open
Checks if the component is open.
is_open(): bool
- returns: bool - True if the component is open and False otherwise.
open
Opens the component.
open(correlation_id: Optional[str])
- correlation_id: Optional[str] - (optional) transaction id used to trace execution through the call chain.
Static methods
from_tuples
Removes all component references that match the specified locator.
staticfrom_tuples(*tuples: Any): ManagedReferences
- locator: Any - locator to remove references by.
- returns: ManagedReferences - list containing all removed references.