Class OMAGServerAdminSecurityServices


  • public class OMAGServerAdminSecurityServices
    extends java.lang.Object
    OMAGServerAdminSecurityServices provides the capability to set up open metadata security connectors. The open metadata security connectors validate the authorization of a user to access specific services and metadata in Egeria. There are 2 connectors: The Open Metadata Platform Security Connector verifies the authorization of calls to the OMAG Server Platform Services that are independent of a server. The Open Metadata Server Security Connector verifies the authorization of calls to a specific server. The connectors are configured with a Connection. The connection for the Open Metadata Server Security Connector is stored in the server's configuration document. The connection for the Open Metadata Platform Security Connector is added dynamically when the platform starts.
    • Constructor Detail

      • OMAGServerAdminSecurityServices

        public OMAGServerAdminSecurityServices()
    • Method Detail

      • setPlatformSecurityConnection

        public VoidResponse setPlatformSecurityConnection​(java.lang.String userId,
                                                          PlatformSecurityRequestBody requestBody)
        Override the default platform security connector.
        Parameters:
        userId - calling user.
        requestBody - containing serverPlatformURL (URL Root of the server platform) and connection used to create and configure the connector.
        Returns:
        void response
      • getPlatformSecurityConnection

        public ConnectionResponse getPlatformSecurityConnection​(java.lang.String userId)
        Return the connection object for the platform security connector.
        Parameters:
        userId - calling user
        Returns:
        connection response
      • clearPlatformSecurityConnection

        public VoidResponse clearPlatformSecurityConnection​(java.lang.String userId)
        Clear the connection object for the platform security connector. This sets the platform security back to default.
        Parameters:
        userId - calling user
        Returns:
        connection response
      • setServerSecurityConnection

        public VoidResponse setServerSecurityConnection​(java.lang.String userId,
                                                        java.lang.String serverName,
                                                        Connection connection)
        Override the default server security connector.
        Parameters:
        userId - calling user.
        serverName - server to configure
        connection - connection used to create and configure the connector.
        Returns:
        void response
      • getServerSecurityConnection

        public ConnectionResponse getServerSecurityConnection​(java.lang.String userId,
                                                              java.lang.String serverName)
        Return the connection object for the server security connector.
        Parameters:
        userId - calling user
        serverName - server to retrieve configuration from
        Returns:
        connection response
      • clearServerSecurityConnection

        public VoidResponse clearServerSecurityConnection​(java.lang.String userId,
                                                          java.lang.String serverName)
        Clear the connection object for the server security connector. This sets the server security back to default.
        Parameters:
        userId - calling user
        serverName - server to configure
        Returns:
        connection response