Package org.odpi.openmetadata.platformservices.server

Class OMAGServerPlatformActiveServices

  • public class OMAGServerPlatformActiveServices
extends Object
    OMAGServerPlatformActiveServices allow an external caller to determine which servers are active on the platform and the services that are active within them.

    • Constructor Detail

      • OMAGServerPlatformActiveServices

        public OMAGServerPlatformActiveServices()

    • Method Detail

      • getRegisteredAccessServices

        public RegisteredOMAGServicesResponse getRegisteredAccessServices​(String userId)
        Return the list of access services that are registered (supported) in this OMAG Server Platform and can be configured in a metadata access point or metadata server.
        Parameters:
        userId - calling user
        Returns:
        list of service descriptions

      • getRegisteredEngineServices

        public RegisteredOMAGServicesResponse getRegisteredEngineServices​(String userId)
        Return the list of engine services that are registered (supported) in this OMAG Server Platform and can be configured in an engine hosting OMAG server.
        Parameters:
        userId - calling user
        Returns:
        list of service descriptions

      • getRegisteredIntegrationServices

        public RegisteredOMAGServicesResponse getRegisteredIntegrationServices​(String userId)
        Return the list of integration services that are implemented in this OMAG Server Platform and can be configured in an integration daemon.
        Parameters:
        userId - calling user
        Returns:
        list of service descriptions

      • getRegisteredViewServices

        public RegisteredOMAGServicesResponse getRegisteredViewServices​(String userId)
        Return the list of view services that are registered (supported) in this OMAG Server Platform and can be configured in a view server.
        Parameters:
        userId - calling user
        Returns:
        list of service descriptions

      • getRegisteredGovernanceServices

        public RegisteredOMAGServicesResponse getRegisteredGovernanceServices​(String userId)
        Return the list of governance services that are registered (supported) in this OMAG Server Platform and can be configured as part of a governance server.
        Parameters:
        userId - calling user
        Returns:
        list of service descriptions

      • getRegisteredCommonServices

        public RegisteredOMAGServicesResponse getRegisteredCommonServices​(String userId)
        Return the list of common services that are registered (supported) in this OMAG Server Platform. These services are use in all types of servers.
        Parameters:
        userId - calling user
        Returns:
        list of service descriptions

      • getAllRegisteredServices

        public RegisteredOMAGServicesResponse getAllRegisteredServices​(String userId)
        Return the list of all services that are registered (supported) in this OMAG Server Platform.
        Parameters:
        userId - calling user
        Returns:
        list of service descriptions

      • isServerKnown

        public BooleanResponse isServerKnown​(String userId,
                                     String serverName)
        Return a flag to indicate if this server has ever run on this OMAG Server Platform.
        Parameters:
        userId - calling user
        serverName - server of interest
        Returns:
        flag

      • getKnownServerList

        public ServerListResponse getKnownServerList​(String userId)
        Return the list of OMAG Servers that have run or are running in this OMAG Server Platform.
        Parameters:
        userId - calling user
        Returns:
        list of OMAG server names

      • getActiveServerList

        public ServerListResponse getActiveServerList​(String userId)
        Return the list of OMAG Servers that are active on this OMAG Server Platform.
        Parameters:
        userId - name of the user making the request
        Returns:
        list of server names

      • getServerStatus

        public ServerStatusResponse getServerStatus​(String userId,
                                            String serverName)
        Return information about when the server has been active.
        Parameters:
        userId - name of the user making the request
        serverName - name of the server of interest
        Returns:
        details of the server status

      • getActiveServiceListForServer

        public ServerServicesListResponse getActiveServiceListForServer​(String userId,
                                                                String serverName)
        Return the list of services that are active on a specific OMAG Server that is active on this OMAG Server Platform.
        Parameters:
        userId - name of the user making the request
        serverName - name of the server of interest
        Returns:
        List of service names