pyegeria 5.4.0.28__py3-none-any.whl → 5.5.3.3__py3-none-any.whl

pyegeria/{full_omag_server_config.py → omvs/full_omag_server_config.py}

@@ -7,14 +7,14 @@ Copyright Contributors to the ODPi Egeria project.
 """
 
 import json
-from pyegeria.utils import body_slimmer
-from pyegeria._client import Client
-from pyegeria import TEMPLATE_GUIDS, max_paging_size
-from pyegeria._exceptions import  InvalidParameterException
-from pyegeria._globals import enable_ssl_check
-from pyegeria._validators import validate_name, validate_url
+from typing import Any, Optional
+from pyegeria.core._exceptions import (
+    PyegeriaInvalidParameterException,
+    PyegeriaAPIException,
+)
+from pyegeria.core._validators import validate_name, validate_url
 
-from .core_omag_server_config import CoreServerConfig
+from pyegeria.omvs.core_omag_server_config import CoreServerConfig
 
 
 class FullServerConfig(CoreServerConfig):
@@ -41,12 +41,12 @@ class FullServerConfig(CoreServerConfig):
         server_name: str,
         platform_url: str,
         user_id: str,
-        user_pwd: str = None,
+        user_pwd: Optional[str] = None,
     ):
         self.full_config_command_root: str
         CoreServerConfig.__init__(self, server_name, platform_url, user_id, user_pwd)
         self.full_config_command_root = (
-            self.platform_url + "/open-metadata/admin-services/users/" + user_id
+            self.platform_url + "/open-metadata/admin-services"
         )
 
     def get_access_services_topic_names(
@@ -198,9 +198,9 @@ class FullServerConfig(CoreServerConfig):
         Raises
         ------
 
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the client passes incorrect parameters on the request - such as bad URLs or invalid values
-        PropertyServerException
+        PyegeriaAPIException
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException
             The principle specified by the user_id does not have authorization for the requested action
@@ -238,7 +238,7 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response status code is not 200 and the related HTTP code is not 200.
 
         """
@@ -275,9 +275,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException:
+        PyegeriaInvalidParameterException:
             If the client passes incorrect parameters on the request - such as bad URLs or invalid values
-        PropertyServerException:
+        PyegeriaAPIException:
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException:
             The principle specified by the user_id does not have authorization for the requested action
@@ -318,15 +318,19 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
-            If the cohort_config_body is None.
+        PyegeriaInvalidParameterException
+            If the `cohort_config_body` is None.
 
         """
         if server_name is None:
             server_name = self.server_name
         validate_name(cohort_name)
         if cohort_config_body is None:
-            raise InvalidParameterException(cohort_config_body)
+            raise PyegeriaInvalidParameterException(
+                None,
+                context={"caller_method": "set_cohort_config"},
+                additional_info={"reason": "cohort_config_body is None"},
+            )
 
         url = (
             self.full_config_command_root
@@ -354,9 +358,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-         InvalidParameterException
+         PyegeriaInvalidParameterException
              If the client passes incorrect parameters on the request - such as bad URLs or invalid values
-         PropertyServerException
+         PyegeriaAPIException
              Raised by the server when an issue arises in processing a valid request
          NotAuthorizedException
              The principle specified by the user_id does not have authorization for the requested action
@@ -422,7 +426,7 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the request to retrieve the topic name fails or returns an invalid parameter code.
 
         """
@@ -553,7 +557,7 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response from the server has a relatedHTTPCode other than 200.
 
         """
@@ -602,7 +606,7 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response code is not 200 after making the POST request.
 
         """
@@ -627,9 +631,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-         InvalidParameterException
+         PyegeriaInvalidParameterException
              If the client passes incorrect parameters on the request - such as bad URLs or invalid values
-         PropertyServerException
+         PyegeriaAPIException
              Raised by the server when an issue arises in processing a valid request
          NotAuthorizedException
              The principle specified by the user_id does not have authorization for the requested action
@@ -651,7 +655,7 @@ class FullServerConfig(CoreServerConfig):
         if related_code == 200:
             return
         else:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
 
     def clear_stored_configuration(self, server_name: str = None) -> None | str:
         """Retrieves the stored configurations for a server
@@ -665,9 +669,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-         InvalidParameterException
+         PyegeriaInvalidParameterException
              If the client passes incorrect parameters on the request - such as bad URLs or invalid values
-         PropertyServerException
+         PyegeriaAPIException
              Raised by the server when an issue arises in processing a valid request
          NotAuthorizedException
              The principle specified by the user_id does not have authorization for the requested action
@@ -689,7 +693,7 @@ class FullServerConfig(CoreServerConfig):
         if related_code == 200:
             return
         else:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
 
     def deploy_stored_configurations(
         self, target_url_root: str, server_name: str = None
@@ -705,12 +709,12 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
-            If the response status code is not 200 and the related HTTP code is also not 200.
-        PropertyServerException:
-            Raised by the server when an issue arises in processing a valid request
-        NotAuthorizedException:
-            The principle specified by the user_id does not have authorization for the requested action
+        PyegeriaInvalidParameterException
+            If the client passes incorrect parameters on the request — such as bad URLs or invalid values.
+        PyegeriaAPIException
+            Raised by the server when an issue arises in processing a valid request.
+        PyegeriaUnauthorizedException
+            The principal specified by the `user_id` does not have authorization for the requested action.
 
         """
         if server_name is None:
@@ -735,12 +739,12 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
-            If the response status code is not 200 and the related HTTP code is also not 200.
-        PropertyServerException:
-            Raised by the server when an issue arises in processing a valid request
-        NotAuthorizedException:
-            The principle specified by the user_id does not have authorization for the requested action
+        PyegeriaInvalidParameterException
+            If the client passes incorrect parameters on the request — such as bad URLs or invalid values.
+        PyegeriaAPIException
+            Raised by the server when an issue arises in processing a valid request.
+        PyegeriaUnauthorizedException
+            The principal specified by the `user_id` does not have authorization for the requested action.
 
         """
         if server_name is None:
@@ -773,8 +777,8 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
-            If the response status code is not 200 and the related HTTP code is also not 200.
+        PyegeriaInvalidParameterException
+            If the client passes incorrect parameters on the request — such as bad URLs or invalid values.
 
         Description
         -----------
@@ -810,8 +814,8 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
-            If the response status code is not 200 and the related HTTP code is also not 200.
+        PyegeriaInvalidParameterException
+            If the client passes incorrect parameters on the request — such as bad URLs or invalid values.
 
         Description
         -----------
@@ -833,7 +837,7 @@ class FullServerConfig(CoreServerConfig):
         response = self.make_request("POST", url, payload=body)
         related_code = response.json().get("relatedHTTPCode")
         if related_code != 200:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
         else:
             return
 
@@ -856,9 +860,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response code is not 200.
-        PropertyServerException:
+        PyegeriaAPIException:
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException:
             The principle specified by the user_id does not have authorization for the requested action
@@ -877,7 +881,7 @@ class FullServerConfig(CoreServerConfig):
         response = self.make_request("POST", url)
         related_code = response.json().get("relatedHTTPCode")
         if related_code != 200:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
         else:
             return
 
@@ -890,7 +894,7 @@ class FullServerConfig(CoreServerConfig):
         response = self.make_request("POST", url)
         related_code = response.json().get("relatedHTTPCode")
         if related_code != 200:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
         else:
             return
 
@@ -901,7 +905,7 @@ class FullServerConfig(CoreServerConfig):
         response = self.make_request("POST", url)
         related_code = response.json().get("relatedHTTPCode")
         if related_code != 200:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
         else:
             return
 
@@ -919,7 +923,7 @@ class FullServerConfig(CoreServerConfig):
         response = self.make_request("POST", url, payload=repository_body)
         related_code = response.json().get("relatedHTTPCode")
         if related_code != 200:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
         else:
             return
 
@@ -950,9 +954,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response code is not 200.
-        PropertyServerException:
+        PyegeriaAPIException:
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException:
             The principle specified by the user_id does not have authorization for the requested action
@@ -975,7 +979,7 @@ class FullServerConfig(CoreServerConfig):
         response = self.make_request("POST", url, payload=archives_list_body)
         related_code = response.json().get("relatedHTTPCode")
         if related_code != 200:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
         else:
             return
 
@@ -999,9 +1003,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response code is not 200.
-        PropertyServerException:
+        PyegeriaAPIException:
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException:
             The principle specified by the user_id does not have authorization for the requested action
@@ -1021,7 +1025,7 @@ class FullServerConfig(CoreServerConfig):
         response = self.make_request("POST", url, server_desc)
         related_code = response.json().get("relatedHTTPCode")
         if related_code != 200:
-            raise InvalidParameterException(response.content)
+            raise PyegeriaAPIException(response)
         else:
             return
 
@@ -1042,9 +1046,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response code is not 200.
-        PropertyServerException:
+        PyegeriaAPIException:
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException:
             The principle specified by the user_id does not have authorization for the requested action
@@ -1078,9 +1082,9 @@ class FullServerConfig(CoreServerConfig):
 
             Raises
             ------
-            InvalidParameterException
+            PyegeriaInvalidParameterException
                 If the response code is not 200.
-            PropertyServerException:
+            PyegeriaAPIException:
                 Raised by the server when an issue arises in processing a valid request
             NotAuthorizedException:
                 The principle specified by the user_id does not have authorization for the requested action
@@ -1114,9 +1118,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response code is not 200.
-        PropertyServerException:
+        PyegeriaAPIException:
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException:
             The principle specified by the user_id does not have authorization for the requested action
@@ -1157,9 +1161,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response code is not 200.
-        PropertyServerException:
+        PyegeriaAPIException:
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException:
             The principle specified by the user_id does not have authorization for the requested action
@@ -1195,9 +1199,9 @@ class FullServerConfig(CoreServerConfig):
 
         Raises
         ------
-        InvalidParameterException
+        PyegeriaInvalidParameterException
             If the response code is not 200.
-        PropertyServerException:
+        PyegeriaAPIException:
             Raised by the server when an issue arises in processing a valid request
         NotAuthorizedException:
             The principle specified by the user_id does not have authorization for the requested action
@@ -1238,7 +1242,7 @@ class FullServerConfig(CoreServerConfig):
         service_url_marker: str,
         integration_service_options: dict,
         connector_configs: list,
-        server_name: str = None,
+        server_name: Optional[str] = None,
     ) -> None:
         if server_name is None:
             server_name = self.server_name
@@ -1273,7 +1277,7 @@ class FullServerConfig(CoreServerConfig):
         remote_omag_platform_url: str,
         integration_service_options: dict,
         connector_configs: dict,
-        server_name: str = None,
+        server_name: Optional[str] = None,
     ) -> None:
         if server_name is None:
             server_name = self.server_name