Package org.odpi.openmetadata.platformservices.server

Class OMAGServerPlatformActiveServices

java.lang.Object
org.odpi.openmetadata.platformservices.server.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 Summary

    Constructors
    Constructor
    Description
    OMAGServerPlatformActiveServices()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.platformservices.rest.ServerListResponse
    getActiveServerList(String userId)
    Return the list of OMAG Servers that are active on this OMAG Server Platform.
    org.odpi.openmetadata.serveroperations.rest.ServerServicesListResponse
    getActiveServicesForServer(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.
    org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse
    getAllRegisteredServices(String userId)
    Return the list of all services that are registered (supported) in this OMAG Server Platform.
    org.odpi.openmetadata.commonservices.ffdc.rest.OCFConnectorTypeResponse
    getConnectorType(String userId, String connectorProviderClassName)
    Return the connector type for the requested connector provider after validating that the connector provider is available on the OMAGServerPlatform's class path.
    org.odpi.openmetadata.platformservices.rest.ServerListResponse
    getKnownServerList(String userId)
    Return the list of OMAG Servers that have run or are running in this OMAG Server Platform.
    Date
    getPlatformStartTime(String userId)
    Return the start time for this instance of the platform.
    org.odpi.openmetadata.commonservices.ffdc.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse
    getRegisteredCommonServices(String userId)
    Return the list of common services that are registered (supported) in this OMAG Server Platform.
    org.odpi.openmetadata.commonservices.ffdc.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.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.
    org.odpi.openmetadata.serveroperations.rest.ServerStatusResponse
    getServerStatus(String userId, String serverName)
    Return information about when the server has been active.
    org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse
    isServerKnown(String userId, String serverName)
    Return a flag to indicate if this server has ever run on this OMAG Server Platform.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    shutdownPlatform(String userId)
    Shutdown this OMAG Server Platform.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • OMAGServerPlatformActiveServices

      public OMAGServerPlatformActiveServices()

  • Method Details

    • getPlatformStartTime

      public Date getPlatformStartTime(String userId)
      Return the start time for this instance of the platform.
      Parameters:
      userId - calling user
      Returns:
      start date/time

    • getRegisteredAccessServices

      public org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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

    • getConnectorType

      public org.odpi.openmetadata.commonservices.ffdc.rest.OCFConnectorTypeResponse getConnectorType(String userId, String connectorProviderClassName)
      Return the connector type for the requested connector provider after validating that the connector provider is available on the OMAGServerPlatform's class path. This method is for tools that are configuring connectors into an Egeria server. It does not validate that the connector will load and initialize.
      Parameters:
      userId - calling user
      connectorProviderClassName - name of the connector provider class
      Returns:
      ConnectorType bean or exceptions that occur when trying to create the connector

    • isServerKnown

      public org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.platformservices.rest.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 org.odpi.openmetadata.platformservices.rest.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 org.odpi.openmetadata.serveroperations.rest.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

    • getActiveServicesForServer

      public org.odpi.openmetadata.serveroperations.rest.ServerServicesListResponse getActiveServicesForServer(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

    • shutdownPlatform

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse shutdownPlatform(String userId)
      Shutdown this OMAG Server Platform.
      Parameters:
      userId - name of the user making the request
      Returns:
      List of service names