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

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

@@ -8,59 +8,65 @@ Copyright Contributors to the ODPi Egeria project.
 
 import asyncio
 import inspect
-import json
 
 import httpx
-
-from pyegeria._client_new import Client2, enable_ssl_check
-from pyegeria._exceptions import (
-    InvalidParameterException,
-    OMAGCommonErrorCode,
-    PropertyServerException,
-    UserNotAuthorizedException,
-    print_exception_response,
+from typing import Any, Optional
+from pyegeria.core._base_platform_client import BasePlatformClient
+from pyegeria.core._globals import enable_ssl_check
+from pyegeria.core._exceptions import (
+    PyegeriaAPIException,
+    PyegeriaConnectionException,
+    PyegeriaException,
+    print_basic_exception,
 )
-from pyegeria._validators import validate_user_id
-from pyegeria._globals import NO_ELEMENTS_FOUND
+from pyegeria.core._validators import validate_user_id
 
-class Platform(Client2):
-    """
-    Client to operate Egeria Platforms - inherits from Server Ops
-
-    Attributes:
-        server_name: str
-                Name of the server to use.
-        platform_url : str
-            URL of the server platform to connect to
-        user_id : str
-            The identity of the user calling the method - this sets a default optionally used by the methods
-            when the user doesn't pass the user_id on a method call.
-        user_pwd: str
-            The password associated with the user_id. Defaults to None
 
+class Platform(BasePlatformClient):
+    """
+    Client for Egeria Platform Services.
+
+    The Platform Services provide methods to manage the OMAG Server Platform
+    and its hosted servers, including activating/deactivating servers and
+    querying their status.
+
+    Attributes
+    ----------
+    server_name : str
+        Name of the server to use.
+    platform_url : str
+        URL of the server platform to connect to.
+    user_id : str
+        The identity of the user calling the method.
+    user_pwd : str
+        The password associated with the user_id. Defaults to None.
     """
 
     platform_command_root: str
 
     def __init__(
-        self, server_name: str, platform_url: str, user_id: str, user_pwd: str = None
+        self,
+        server_name: str,
+        platform_url: str,
+        user_id: str,
+        user_pwd: Optional[str] = None,
+        token: Optional[str] = None,
     ):
         validate_user_id(
             user_id
         )  # add this check since we aren't using bearer tokens in this class
 
-        Client2.__init__(self, server_name, platform_url, user_id, user_pwd)
+        BasePlatformClient.__init__(self, server_name, platform_url, user_id, user_pwd, token=token)
         self.admin_command_root = (
             self.platform_url
-            + "/open-metadata/platform-services/users/"
-            + user_id
-            + "/server-platform"
+            + "/open-metadata/platform-services/"
+            + "server-platform"
         )
 
     def get_platform_origin(self) -> str:
         """Get the version and origin of the platform software
 
-         /open-metadata/platform-services/users/{userId}/server-platform/origin
+         /open-metadata/platform-services/server-platform/origin
          Response from this call is a string not JSON..
 
          Parameters
@@ -72,13 +78,12 @@ class Platform(Client2):
 
         Raises
         ------
-
-        InvalidParameterException
-          If the client passes incorrect parameters on the request - such as bad URLs or invalid values
-        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.
         """
 
         global response
@@ -86,61 +91,19 @@ class Platform(Client2):
         caller_method = inspect.getframeinfo(calling_frame).function
         class_name = __class__.__name__
 
-        url = self.admin_command_root + "/origin"
+        # url = f"{self.platform_url}/open-metadata/platform-services/server-platform/origin"
+        url = f"{self.platform_url}/api/about"
 
         local_session = httpx.Client(verify=enable_ssl_check)
         response = " "
         try:
             response = local_session.get(url)
             if response.status_code != 200:
-                msg = (
-                    OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                        "message_template"
-                    ].format(
-                        response.status_code,
-                        caller_method,
-                        class_name,
-                        url,
-                        OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                            "message_id"
-                        ],
-                    )
-                    + "==>System reports:'"
-                    + response.reason_phrase
-                    + "'"
-                )
-                exc_msg = json.dumps(
-                    {
-                        "class": "VoidResponse",
-                        "relatedHTTPCode": response.status_code,
-                        "exceptionClassName": "InvalidParameterException",
-                        "actionDescription": caller_method,
-                        "exceptionErrorMessage": msg,
-                        "exceptionErrorMessageId": OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                            "message_id"
-                        ],
-                        "exceptionErrorMessageParameters": [
-                            url,
-                            self.server_name,
-                            self.user_id,
-                        ],
-                        "exceptionSystemAction": OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                            "system_action"
-                        ],
-                        "exceptionUserAction": OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                            "user_action"
-                        ],
-                        "exceptionProperties": {
-                            "endpoint": url,
-                            "server": self.server_name,
-                            "user_id": self.user_id,
-                        },
-                    }
-                )
-                raise InvalidParameterException(exc_msg)
+                # Server returned non-200; raise API exception with response context
+                raise PyegeriaAPIException(response)
             else:
                 return response.text
-        except InvalidParameterException:
+        except PyegeriaException:
             raise
 
         except (
@@ -150,51 +113,16 @@ class Platform(Client2):
             httpx.TimeoutException,
         ) as e:
             msg = (
-                OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                    "message_template"
-                ].format(
-                    e.args[0],
-                    caller_method,
-                    class_name,
-                    url,
-                    OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value["message_id"],
-                )
-                + "==>System reports:'"
-                + response.reason_phrase
-                + "'"
+                f"Client error in {caller_method} for {class_name} calling {url}: {str(e)}"
             )
-            exc_msg = json.dumps(
-                {
-                    "class": "VoidResponse",
-                    "relatedHTTPCode": 400,
-                    "exceptionClassName": "InvalidParameterException",
-                    "actionDescription": caller_method,
-                    "exceptionErrorMessage": msg,
-                    "exceptionErrorMessageId": OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                        "message_id"
-                    ],
-                    "exceptionErrorMessageParameters": [
-                        url,
-                        self.server_name,
-                        self.user_id,
-                    ],
-                    "exceptionSystemAction": OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                        "system_action"
-                    ],
-                    "exceptionUserAction": OMAGCommonErrorCode.CLIENT_SIDE_REST_API_ERROR.value[
-                        "user_action"
-                    ],
-                    "exceptionProperties": {
-                        "endpoint": url,
-                        "server": self.server_name,
-                        "user_id": self.user_id,
-                    },
-                }
+            raise PyegeriaConnectionException(
+                context={"caller_method": caller_method, "class": class_name, "url": url},
+                additional_info={"message": msg},
+                e=e,
             )
-            raise InvalidParameterException(exc_msg)
 
     async def _async_activate_server_stored_config(
-        self, server: str = None, timeout: int = 60
+        self, server: Optional[str] = None, timeout: int = 60
     ) -> None:
         """Activate a server on the associated platform with the stored configuration. Async version.
 
@@ -208,9 +136,9 @@ class Platform(Client2):
 
         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
@@ -223,7 +151,7 @@ class Platform(Client2):
         await self._async_make_request("POST", url, time_out=timeout)
 
     def activate_server_stored_config(
-        self, server: str = None, timeout: int = 90
+        self, server: Optional[str] = None, timeout: int = 90
     ) -> None:
         """Activate a server on the associated platform with the stored configuration.
 
@@ -238,9 +166,9 @@ class Platform(Client2):
 
         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
@@ -252,7 +180,7 @@ class Platform(Client2):
         return response
 
     async def _async_activate_server_supplied_config(
-        self, config_body: dict, server: str = None, timeout: int = 60
+        self, config_body: dict, server: Optional[str] = None, timeout: int = 60
     ) -> None:
         """Activate a server on the associated platform with the stored configuration. Async version.
 
@@ -271,9 +199,9 @@ class Platform(Client2):
 
         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
@@ -285,7 +213,7 @@ class Platform(Client2):
         await self._async_make_request("POST", url, config_body, time_out=timeout)
 
     def activate_server_supplied_config(
-        self, config_body: dict, server: str = None, timeout: int = 60
+        self, config_body: dict, server: Optional[str] = None, timeout: int = 60
     ) -> None:
         """Activate a server on the associated platform with the stored configuration.
 
@@ -304,9 +232,9 @@ class Platform(Client2):
 
         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
@@ -332,9 +260,9 @@ class Platform(Client2):
 
         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
@@ -360,9 +288,9 @@ class Platform(Client2):
 
         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
@@ -385,9 +313,9 @@ class Platform(Client2):
 
         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
@@ -408,9 +336,9 @@ class Platform(Client2):
 
         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
@@ -432,9 +360,9 @@ class Platform(Client2):
 
         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
@@ -459,9 +387,9 @@ class Platform(Client2):
 
         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
@@ -485,7 +413,7 @@ class Platform(Client2):
         """
         if server is None:
             server = self.server_name
-        url = f"{self.platform_url}/open-metadata/admin-services/users/{self.user_id}/servers/{server}/configuration"
+        url = f"{self.platform_url}/open-metadata/admin-services/servers/{server}/configuration"
 
         response = await self._async_make_request("GET", url)
         config = response.json().get("omagserverConfig", "No configuration found")
@@ -600,9 +528,9 @@ class Platform(Client2):
 
         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
@@ -626,9 +554,9 @@ class Platform(Client2):
 
         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,9 +579,9 @@ class Platform(Client2):
 
         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
@@ -677,9 +605,9 @@ class Platform(Client2):
 
         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
@@ -700,9 +628,9 @@ class Platform(Client2):
 
         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
@@ -726,9 +654,9 @@ class Platform(Client2):
 
         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
@@ -740,7 +668,7 @@ class Platform(Client2):
         """
         Shutdown and unregister all servers from their cohorts on the associated platform. Async version.
 
-        /open-metadata/platform-services/users/{userId}/server-platform/servers
+        /open-metadata/platform-services/server-platform/servers
 
         Parameters
         ----------
@@ -751,9 +679,9 @@ class Platform(Client2):
 
         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
@@ -767,7 +695,7 @@ class Platform(Client2):
         """
         Shutdown and unregister all servers from their cohorts on the associated platform.
 
-        /open-metadata/platform-services/users/{userId}/server-platform/servers
+        /open-metadata/platform-services/server-platform/servers
 
         Parameters
         ----------
@@ -778,9 +706,9 @@ class Platform(Client2):
 
         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
@@ -801,9 +729,9 @@ class Platform(Client2):
 
         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
@@ -825,9 +753,9 @@ class Platform(Client2):
 
         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
@@ -855,9 +783,9 @@ class Platform(Client2):
 
         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
@@ -888,14 +816,10 @@ class Platform(Client2):
                     print(f"      OMAG Server {server} needs to be configured")
                 return False
 
-        except (
-            InvalidParameterException,
-            PropertyServerException,
-            UserNotAuthorizedException,
-        ) as e:
+        except PyegeriaException as e:
             if verbose:
-                print_exception_response(e)
-            raise e
+                print_basic_exception(e)
+            raise
 
     def activate_server_if_down(
         self, server: str, verbose: bool = True, timeout: int = 60
@@ -917,9 +841,9 @@ class Platform(Client2):
 
         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
@@ -951,9 +875,9 @@ class Platform(Client2):
 
         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
@@ -1004,9 +928,9 @@ class Platform(Client2):
 
         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
@@ -1074,13 +998,9 @@ class Platform(Client2):
                 return
             else:
                 print(f"   {platform_name}, is down - start it before proceeding")
-        except (
-            InvalidParameterException,
-            PropertyServerException,
-            UserNotAuthorizedException,
-        ) as e:
+        except PyegeriaException as e:
             print(f"   {platform_name}, is down - start it before proceeding")
-            print_exception_response(e)
+            print_basic_exception(e)
 
     def activate_platform(
         self, platform_name: str, hosted_server_names: [str], timeout: int = 60