Loading src/service/service/service_handler_api/_ServiceHandler.py +87 −58 Original line number Diff line number Diff line Loading @@ -19,10 +19,12 @@ from device.client.DeviceClient import DeviceClient from service.service.database.ServiceModel import ServiceModel class _ServiceHandler: def __init__( self, db_service : ServiceModel, database : Database, context_client : ContextClient, device_client : DeviceClient, **settings ) -> None: def __init__(self, db_service: ServiceModel, database: Database, context_client: ContextClient, device_client: DeviceClient, **settings) -> None: """ Initialize Driver. Parameters: db_service Loading @@ -30,94 +32,121 @@ class _ServiceHandler: database The instance of the local in-memory database. context_client An instance of context client to be used to retrieve information from the service and the devices. An instance of context client to be used to retrieve information from the service and the devices. device_client An instance of device client to be used to configure the devices. An instance of device client to be used to configure the devices. **settings Extra settings required by the service handler. """ raise NotImplementedError() def SetEndpoint(self, endpoints : List[Tuple[str, str, Optional[str]]]) -> List[Union[bool, Exception]]: """ Set endpoints from a list. def SetEndpoint(self, endpoints: List[Tuple[str, str, Optional[str]]]) \ -> List[Union[bool, Exception]]: """ Create/Update service endpoints. Parameters: endpoints: List[Tuple[str, str, Optional[str]]] List of tuples, each containing a device_uuid, endpoint_uuid and, optionally, the topology_uuid List of tuples, each containing a device_uuid, endpoint_uuid and, optionally, the topology_uuid of the endpoint to be added. Returns: results: List[Union[bool, Exception]] List of results for endpoint changes requested. Return values must be in the same order than endpoints requested. If an endpoint is properly added, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for endpoint changes requested. Return values must be in the same order as the requested endpoints. If an endpoint is properly added, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def DeleteEndpoint(self, endpoints : List[Tuple[str, str, Optional[str]]]) -> List[Union[bool, Exception]]: """ Delete endpoints form a list. def DeleteEndpoint(self, endpoints: List[Tuple[str, str, Optional[str]]]) \ -> List[Union[bool, Exception]]: """ Delete service endpoints. Parameters: endpoints: List[Tuple[str, str, Optional[str]]] List of tuples, each containing a device_uuid, endpoint_uuid, and the topology_uuid of the endpoint List of tuples, each containing a device_uuid, endpoint_uuid, and the topology_uuid of the endpoint to be removed. Returns: results: List[Union[bool, Exception]] List of results for endpoint deletions requested. Return values must be in the same order than endpoints requested. If an endpoint is properly deleted, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for endpoint deletions requested. Return values must be in the same order as the requested endpoints. If an endpoint is properly deleted, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def SetConstraint(self, constraints : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]: """ Create/Update constraints. def SetConstraint(self, constraints: List[Tuple[str, Any]]) \ -> List[Union[bool, Exception]]: """ Create/Update service constraints. Parameters: constraints: List[Tuple[str, Any]] List of tuples, each containing a constraint_type and the new constraint_value to be set. List of tuples, each containing a constraint_type and the new constraint_value to be set. Returns: results: List[Union[bool, Exception]] List of results for constraint changes requested. Return values must be in the same order than constraints requested. If a constraint is properly set, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for constraint changes requested. Return values must be in the same order as the requested constraints. If a constraint is properly set, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def DeleteConstraint(self, constraints : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]: """ Delete constraints. def DeleteConstraint(self, constraints: List[Tuple[str, Any]]) \ -> List[Union[bool, Exception]]: """ Delete service constraints. Parameters: constraints: List[Tuple[str, Any]] List of tuples, each containing a constraint_type pointing to the constraint to be deleted, and a constraint_value containing possible additionally required values to locate the constraint to be removed. List of tuples, each containing a constraint_type pointing to the constraint to be deleted, and a constraint_value containing possible additionally required values to locate the constraint to be removed. Returns: results: List[Union[bool, Exception]] List of results for constraint deletions requested. Return values must be in the same order than constraints requested. If a constraint is properly deleted, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for constraint deletions requested. Return values must be in the same order as the requested constraints. If a constraint is properly deleted, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def SetConfig(self, resources : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]: """ Create/Update configuration for a list of resources. def SetConfig(self, resources: List[Tuple[str, Any]]) \ -> List[Union[bool, Exception]]: """ Create/Update configuration for a list of service resources. Parameters: resources: List[Tuple[str, Any]] List of tuples, each containing a resource_key pointing the resource to be modified, and a resource_value containing the new value to be set. List of tuples, each containing a resource_key pointing to the resource to be modified, and a resource_value containing the new value to be set. Returns: results: List[Union[bool, Exception]] List of results for resource key changes requested. Return values must be in the same order than resource keys requested. If a resource is properly set, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for resource key changes requested. Return values must be in the same order as the requested resource keys. If a resource is properly set, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def DeleteConfig(self, resources : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]: """ Delete configuration for a list of resources. def DeleteConfig(self, resources: List[Tuple[str, Any]]) \ -> List[Union[bool, Exception]]: """ Delete configuration for a list of service resources. Parameters: resources: List[Tuple[str, Any]] List of tuples, each containing a resource_key pointing the resource to be modified, and a resource_value containing possible additionally required values to locate the value to be removed. List of tuples, each containing a resource_key pointing to the resource to be modified, and a resource_value containing possible additionally required values to locate the value to be removed. Returns: results: List[Union[bool, Exception]] List of results for resource key deletions requested. Return values must be in the same order than resource keys requested. If a resource is properly deleted, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for resource key deletions requested. Return values must be in the same order as the requested resource keys. If a resource is properly deleted, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() Loading
src/service/service/service_handler_api/_ServiceHandler.py +87 −58 Original line number Diff line number Diff line Loading @@ -19,10 +19,12 @@ from device.client.DeviceClient import DeviceClient from service.service.database.ServiceModel import ServiceModel class _ServiceHandler: def __init__( self, db_service : ServiceModel, database : Database, context_client : ContextClient, device_client : DeviceClient, **settings ) -> None: def __init__(self, db_service: ServiceModel, database: Database, context_client: ContextClient, device_client: DeviceClient, **settings) -> None: """ Initialize Driver. Parameters: db_service Loading @@ -30,94 +32,121 @@ class _ServiceHandler: database The instance of the local in-memory database. context_client An instance of context client to be used to retrieve information from the service and the devices. An instance of context client to be used to retrieve information from the service and the devices. device_client An instance of device client to be used to configure the devices. An instance of device client to be used to configure the devices. **settings Extra settings required by the service handler. """ raise NotImplementedError() def SetEndpoint(self, endpoints : List[Tuple[str, str, Optional[str]]]) -> List[Union[bool, Exception]]: """ Set endpoints from a list. def SetEndpoint(self, endpoints: List[Tuple[str, str, Optional[str]]]) \ -> List[Union[bool, Exception]]: """ Create/Update service endpoints. Parameters: endpoints: List[Tuple[str, str, Optional[str]]] List of tuples, each containing a device_uuid, endpoint_uuid and, optionally, the topology_uuid List of tuples, each containing a device_uuid, endpoint_uuid and, optionally, the topology_uuid of the endpoint to be added. Returns: results: List[Union[bool, Exception]] List of results for endpoint changes requested. Return values must be in the same order than endpoints requested. If an endpoint is properly added, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for endpoint changes requested. Return values must be in the same order as the requested endpoints. If an endpoint is properly added, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def DeleteEndpoint(self, endpoints : List[Tuple[str, str, Optional[str]]]) -> List[Union[bool, Exception]]: """ Delete endpoints form a list. def DeleteEndpoint(self, endpoints: List[Tuple[str, str, Optional[str]]]) \ -> List[Union[bool, Exception]]: """ Delete service endpoints. Parameters: endpoints: List[Tuple[str, str, Optional[str]]] List of tuples, each containing a device_uuid, endpoint_uuid, and the topology_uuid of the endpoint List of tuples, each containing a device_uuid, endpoint_uuid, and the topology_uuid of the endpoint to be removed. Returns: results: List[Union[bool, Exception]] List of results for endpoint deletions requested. Return values must be in the same order than endpoints requested. If an endpoint is properly deleted, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for endpoint deletions requested. Return values must be in the same order as the requested endpoints. If an endpoint is properly deleted, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def SetConstraint(self, constraints : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]: """ Create/Update constraints. def SetConstraint(self, constraints: List[Tuple[str, Any]]) \ -> List[Union[bool, Exception]]: """ Create/Update service constraints. Parameters: constraints: List[Tuple[str, Any]] List of tuples, each containing a constraint_type and the new constraint_value to be set. List of tuples, each containing a constraint_type and the new constraint_value to be set. Returns: results: List[Union[bool, Exception]] List of results for constraint changes requested. Return values must be in the same order than constraints requested. If a constraint is properly set, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for constraint changes requested. Return values must be in the same order as the requested constraints. If a constraint is properly set, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def DeleteConstraint(self, constraints : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]: """ Delete constraints. def DeleteConstraint(self, constraints: List[Tuple[str, Any]]) \ -> List[Union[bool, Exception]]: """ Delete service constraints. Parameters: constraints: List[Tuple[str, Any]] List of tuples, each containing a constraint_type pointing to the constraint to be deleted, and a constraint_value containing possible additionally required values to locate the constraint to be removed. List of tuples, each containing a constraint_type pointing to the constraint to be deleted, and a constraint_value containing possible additionally required values to locate the constraint to be removed. Returns: results: List[Union[bool, Exception]] List of results for constraint deletions requested. Return values must be in the same order than constraints requested. If a constraint is properly deleted, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for constraint deletions requested. Return values must be in the same order as the requested constraints. If a constraint is properly deleted, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def SetConfig(self, resources : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]: """ Create/Update configuration for a list of resources. def SetConfig(self, resources: List[Tuple[str, Any]]) \ -> List[Union[bool, Exception]]: """ Create/Update configuration for a list of service resources. Parameters: resources: List[Tuple[str, Any]] List of tuples, each containing a resource_key pointing the resource to be modified, and a resource_value containing the new value to be set. List of tuples, each containing a resource_key pointing to the resource to be modified, and a resource_value containing the new value to be set. Returns: results: List[Union[bool, Exception]] List of results for resource key changes requested. Return values must be in the same order than resource keys requested. If a resource is properly set, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for resource key changes requested. Return values must be in the same order as the requested resource keys. If a resource is properly set, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError() def DeleteConfig(self, resources : List[Tuple[str, Any]]) -> List[Union[bool, Exception]]: """ Delete configuration for a list of resources. def DeleteConfig(self, resources: List[Tuple[str, Any]]) \ -> List[Union[bool, Exception]]: """ Delete configuration for a list of service resources. Parameters: resources: List[Tuple[str, Any]] List of tuples, each containing a resource_key pointing the resource to be modified, and a resource_value containing possible additionally required values to locate the value to be removed. List of tuples, each containing a resource_key pointing to the resource to be modified, and a resource_value containing possible additionally required values to locate the value to be removed. Returns: results: List[Union[bool, Exception]] List of results for resource key deletions requested. Return values must be in the same order than resource keys requested. If a resource is properly deleted, True must be retrieved; otherwise, the Exception that is raised during the processing must be retrieved. List of results for resource key deletions requested. Return values must be in the same order as the requested resource keys. If a resource is properly deleted, True must be returned; otherwise, the Exception that is raised during the processing must be returned. """ raise NotImplementedError()
