Package org.odpi.openmetadata.platformservices.server

Class OMAGServerPlatformActiveServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.platformservices.server.OMAGServerPlatformActiveServices
public class OMAGServerPlatformActiveServices extends TokenController
OMAGServerPlatformActiveServices allow an external caller to determine which servers are active on the platform and the services that are active within them.

  • Constructor Details

    • OMAGServerPlatformActiveServices

      public OMAGServerPlatformActiveServices()

  • Method Details

    • getPlatformStartTime

      public DateResponse getPlatformStartTime(String delegatingUserId)
      Return the start time for this instance of the platform.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      start date/time

    • getServerPlatformOrganizationName

      public StringResponse getServerPlatformOrganizationName(String delegatingUserId)
      Return the name of the organization running this platform.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      String description or UserNotAuthorizedException userId is not recognized

    • getRegisteredAccessServices

      public RegisteredOMAGServicesResponse getRegisteredAccessServices(String delegatingUserId)
      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:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getRegisteredEngineServices

      public RegisteredOMAGServicesResponse getRegisteredEngineServices(String delegatingUserId)
      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:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getRegisteredViewServices

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

    • getRegisteredGovernanceServices

      public RegisteredOMAGServicesResponse getRegisteredGovernanceServices(String delegatingUserId)
      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:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getRegisteredCommonServices

      public RegisteredOMAGServicesResponse getRegisteredCommonServices(String delegatingUserId)
      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:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getAllRegisteredServices

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

    • getConnectorType

      public OCFConnectorTypeResponse getConnectorType(String connectorProviderClassName, String delegatingUserId)
      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:
      delegatingUserId - external userId making request
      connectorProviderClassName - name of the connector provider class
      Returns:
      ConnectorType bean or exceptions that occur when trying to create the connector

    • isServerKnown

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

    • getKnownServerList

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

    • getActiveServerList

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

    • getServerStatus

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

    • getActiveServicesForServer

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