pyegeria 0.2.4__py3-none-any.whl → 5.3.0.dev3__py3-none-any.whl

pyegeria/server_operations.py

@@ -6,20 +6,21 @@ Copyright Contributors to the ODPi Egeria project.
 
 """
 
+import asyncio
+
 from requests import Response
 
-from pyegeria.exceptions import (
-    InvalidParameterException,
-)
 from pyegeria import Platform
-import asyncio
+from pyegeria._validators import validate_name
+
 
 class ServerOps(Platform):
     """
     Client to issue operations on a running OMAG server.
 
     Attributes:
-
+        server_name: str
+            Name of the server to use.
         platform_url : str
             URL of the server platform to connect to
         user_id : str
@@ -27,33 +28,20 @@ class ServerOps(Platform):
             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
-        verify_flag: bool
-            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
-            Defaults to False.
-
-    Methods:
-        __init__(self,
-                 platform_url: str,
-                 end_user_id: str,
-                 )
-         Initializes the connection - throwing an exception if there is a problem
 
     """
 
-
     def __init__(
-            self,
-            server_name: str,
-            platform_url: str,
-            user_id: str,
-            user_pwd: str = None,
-            verify_flag: bool = False,
+        self,
+        server_name: str,
+        platform_url: str,
+        user_id: str,
+        user_pwd: str = None,
     ):
-        Platform.__init__(self, server_name, platform_url, user_id, user_pwd, verify_flag)
-        self.ops_command_root = (self.platform_url +
-                                   "/open-metadata/server-operations/users/" +
-                                   user_id)
-
+        Platform.__init__(self, server_name, platform_url, user_id, user_pwd)
+        self.ops_command_root = (
+            f"{self.platform_url}/open-metadata/server-operations/users/{user_id}"
+        )
 
     async def _async_get_active_configuration(self, server: str = None) -> dict | str:
         """
@@ -97,10 +85,12 @@ class ServerOps(Platform):
         response = loop.run_until_complete(self._async_get_active_configuration(server))
         return response
 
-
-
-
-    async def _async_add_archive_file(self, archive_file: str, server: str = None) -> None:
+    #
+    #   Archive Files
+    #
+    async def _async_add_archive_file(
+        self, archive_file: str, server: str = None, timeout: int = 60
+    ) -> None:
         """
         Load the server with the contents of the indicated archive file.
 
@@ -109,7 +99,7 @@ class ServerOps(Platform):
         archive_file: the name of the archive file to load
                 - note that the path is relative to the working directory of the platform.
         server : Use the server if specified. If None, use the default server associated with the Platform object.
-
+        timeout: Timeout in seconds. Defaults to 30 seconds.
         Returns
         -------
         Response object.  Also throws exceptions if no viable server or endpoint errors
@@ -119,14 +109,17 @@ class ServerOps(Platform):
             server = self.server_name
 
         url = (
-                self.ops_command_root
-                + "/servers/" + server
-                + "/instance/open-metadata-archives/file"
+            self.ops_command_root
+            + "/servers/"
+            + server
+            + "/instance/open-metadata-archives/file"
         )
 
-        await self._async_make_request("POST-DATA", url, archive_file)
+        await self._async_make_request("POST-DATA", url, archive_file, time_out=timeout)
 
-    def add_archive_file(self, archive_file: str, server: str = None) -> None:
+    def add_archive_file(
+        self, archive_file: str, server: str = None, timeout: int = 30
+    ) -> None:
         """
         Load the server with the contents of the indicated archive file.
 
@@ -135,6 +128,7 @@ class ServerOps(Platform):
         archive_file: the name of the archive file to load
                 - note that the path is relative to the working directory of the platform.
         server : Use the server if specified. If None, use the default server associated with the Platform object.
+        timeout: Timeout in seconds. Defaults to 30 seconds.
 
         Returns
         -------
@@ -142,10 +136,14 @@ class ServerOps(Platform):
 
         """
         loop = asyncio.get_event_loop()
-        loop.run_until_complete(self._async_add_archive_file(archive_file, server))
+        loop.run_until_complete(
+            self._async_add_archive_file(archive_file, server, timeout)
+        )
 
-    async def _async_add_archive(self, archive_connection: str, server: str = None) -> None:
-        """ Load the server with the contents of the indicated archive file.
+    async def _async_add_archive(
+        self, archive_connection: str, server: str = None
+    ) -> None:
+        """Load the server with the contents of the indicated archive file.
 
         /open-metadata/server-operations/users/{userId}/server-platform/servers/{serverName}/instance/open-metadata-archives/connection
 
@@ -166,13 +164,13 @@ class ServerOps(Platform):
             server = self.server_name
 
         url = (
-                self.ops_command_root
-                + "/servers/" + server
-                + "/instance/open-metadata-archives/connection"
+            self.ops_command_root
+            + "/servers/"
+            + server
+            + "/instance/open-metadata-archives/connection"
         )
         await self._async_make_request("POST-DATA", url, archive_connection)
 
-
     def add_archive(self, archive_connection: str, server: str = None) -> None:
         """
         Load the server with the contents of the indicated archive file.
@@ -192,10 +190,16 @@ class ServerOps(Platform):
 
         """
         loop = asyncio.get_event_loop()
-        loop.run_until_complete(self._async_add_archive_file(archive_connection,server))
+        loop.run_until_complete(
+            self._async_add_archive_file(archive_connection, server)
+        )
+
+    #
+    #   Server Ops
+    #
 
-    async def _async_get_active_server_status(self, server:str = None) -> dict:
-        """  Get the status for the specified server.
+    async def _async_get_active_server_status(self, server: str = None) -> dict:
+        """Get the status for the specified server.
 
         Parameters
         ----------
@@ -248,7 +252,9 @@ class ServerOps(Platform):
         response = loop.run_until_complete(self._async_get_active_server_status(server))
         return response.json()
 
-    async def _async_get_active_service_list_for_server(self, server: str = None) -> Response:
+    async def _async_get_active_service_list_for_server(
+        self, server: str = None
+    ) -> Response:
         """
         List all known active servers on the associated platform.
 
@@ -286,15 +292,21 @@ class ServerOps(Platform):
 
         """
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(self._async_get_active_service_list_for_server(server))
+        response = loop.run_until_complete(
+            self._async_get_active_service_list_for_server(server)
+        )
         return response
 
+    #
+    #   Governance Engine Ops
+    #
     async def _async_get_governance_engine_summaries(self, server: str = None) -> dict:
-        """ Get Governance Engine Summaries. Async version.
+        """Get Governance Engine Summaries. Async version.
         Parameters
         ----------
         server : str, optional
-            The name of the server to get governance engine summaries from. If not provided, the default server name will be used.
+            The name of the server to get governance engine summaries from. If not provided,
+            the default server name will be used.
 
         Returns
         -------
@@ -305,8 +317,10 @@ class ServerOps(Platform):
         if server is None:
             server = self.server_name
 
-        url = (f"{self.platform_url}/servers/{server}/open-metadata/engine-host/users/{self.user_id}"
-               f"/governance-engines/summary")
+        url = (
+            f"{self.platform_url}/servers/{server}/open-metadata/engine-host/users/{self.user_id}"
+            f"/governance-engines/summary"
+        )
         response = await self._async_make_request("GET", url)
         return response.json().get("governanceEngineSummaries")
 
@@ -315,7 +329,8 @@ class ServerOps(Platform):
         Parameters
         ----------
         server : str, optional
-            The name of the server to get governance engine summaries from. If not provided, the default server name will be used.
+            The name of the server to get governance engine summaries from. If not provided,
+            the default server name will be used.
 
         Returns
         -------
@@ -324,38 +339,130 @@ class ServerOps(Platform):
 
         """
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(self._async_get_governance_engine_summaries(server))
+        response = loop.run_until_complete(
+            self._async_get_governance_engine_summaries(server)
+        )
         return response
-#
-# Integration Daemon
-#
-    async def _async_get_integration_daemon_status(self, server: str = None) -> dict | str:
-        """ Get the current status of the integration daemon. Async version.
 
-        """
+    #
+    # Integration Daemon Ops
+    #
+    async def _async_get_integration_daemon_status(
+        self, server: str = None
+    ) -> dict | str:
+        """Get the current status of the integration daemon. Async version."""
         if server is None:
             server = self.server_name
 
-        url = f"{self.platform_url}/servers/{server}/open-metadata/integration-daemon/users/{self.user_id}/status"
+        url = f"{self.platform_url}/servers/{server}/open-metadata/integration_daemon/users/{self.user_id}/status"
         response = await self._async_make_request("GET", url)
         return response.json().get("integrationDaemonStatus", "No Integration Groups")
         # return response.json()
 
     def get_integration_daemon_status(self, server: str = None) -> dict | str:
-        """ Get the current status of the integration daemon. Async version.
+        """Get the current status of the integration daemon. Async version."""
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_integration_daemon_status(server)
+        )
+        return response
+
+    async def _async_get_connector_config(
+        self, connector_name: str, server: str = None
+    ) -> dict | str:
+        """Retrieve the configuration properties of the named integration connector running in the integration daemon
+        - async version"""
+        if server is None:
+            server = self.server_name
+        validate_name(connector_name)
+
+        url = (
+            f"{self.platform_url}/servers/{server}/open-metadata/integration_daemon/users/{self.user_id}/"
+            f"integration-connectors/{connector_name}/configuration-properties"
+        )
+
+        response = await self._async_make_request("GET", url)
+        return response.json()
+
+    def get_connector_config(
+        self, connector_name: str, server: str = None
+    ) -> dict | str:
+        """Retrieve the configuration properties of the named integration connector running in the integration
+        daemon"""
 
-        """
         loop = asyncio.get_event_loop()
-        response = loop.run_until_complete(self._async_get_integration_daemon_status(server))
+        response = loop.run_until_complete(
+            self._async_get_connector_config(connector_name, server)
+        )
         return response
 
-    def get_integration_connector_status(self, server: str = None)-> list:
-        response = self.get_integration_daemon_status(server)
+    def get_integration_connector_status(self, server: str = None) -> None:
+        """Get the current status of the integration connector. Async version."""
+        self.get_integration_daemon_status(server)
+        # todo - finish this? (and do async)
         pass
 
+    async def _async_restart_integration_connector(
+        self, connector_name: str, server: str = None
+    ) -> str:
+        """Restart the integration Connector specified by connector_name or all if not specified - async"""
+
+        if server is None:
+            server = self.server_name
+
+        url = (
+            f"{self.platform_url}/servers/{server}/open-metadata/integration_daemon/users/"
+            f"{self.user_id}/integration-connectors/restart"
+        )
+        body = {"class": "NameRequestBody", "name": connector_name}
+        response = await self._async_make_request("POST", url, body)
+        return response
+
+    def restart_integration_connector(
+        self, connector_name: str, server: str = None
+    ) -> str:
+        """Restart the integration Connector specified by connector_name or all if not specified"""
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_restart_integration_connector(connector_name, server)
+        )
+        return response
+
+    async def _async_refresh_integration_connectors(
+        self, connector_name: str = "all", server: str = None, time_out: int = 60
+    ) -> None:
+        """Issue a refresh request to all connectors running in the integration daemon, or a specific connector
+        if one is specified - async version"""
+        if server is None:
+            server = self.server_name
+        if connector_name == "all":
+            connector_name = None
+
+        url = (
+            f"{self.platform_url}/servers/{server}/open-metadata/integration_daemon/users/"
+            f"{self.user_id}/integration-connectors/refresh"
+        )
+        if connector_name:
+            body = {"class": "NameRequestBody", "name": connector_name}
+            await self._async_make_request("POST", url, body, time_out=time_out)
+        else:
+            await self._async_make_request("POST", url, time_out=time_out)
+
+        return
+
+    def refresh_integration_connectors(
+        self, connector_name: str, server: str = None, time_out: int = 60
+    ) -> None:
+        """Restart the integration Connector specified by connector_name"""
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(
+            self._async_refresh_integration_connectors(connector_name, server, time_out)
+        )
+
 
 if __name__ == "__main__":
-    p = ServerOps("meow", "https://127.0.0.1:9443", "garygeeke", verify_flag=False)
-    response = p.get_active_service_list_for_server()
-    out = response.json()["result"]
-    print(out)
+    # p = ServerOps("meow", "https://127.0.0.1:9443", "garygeeke", verify_flag=False)
+    # response = p.get_active_service_list_for_server()
+    # out = response.json()["result"]
+    # print(out)
+    print("Main-Server Operations")