Package org.odpi.openmetadata.platformservices.server.spring

Class OMAGServerPlatformActiveResource

java.lang.Object
org.odpi.openmetadata.platformservices.server.spring.OMAGServerPlatformActiveResource
@RestController @RequestMapping("/open-metadata/platform-services/server-platform") public class OMAGServerPlatformActiveResource extends Object
OMAGServerPlatformActiveResource allow an external caller to determine which servers are active on the platform and the services that are active within them.

  • Constructor Details

    • OMAGServerPlatformActiveResource

      public OMAGServerPlatformActiveResource()

  • Method Details

    • getPlatformStartTime

      @GetMapping(path="/start-time") public DateResponse getPlatformStartTime(@RequestParam(required=false) String delegatingUserId)
      Return the start time for this instance of the platform.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      start date/time

    • getServerPlatformOrganizationName

      @GetMapping(path="/organization-name") public StringResponse getServerPlatformOrganizationName(@RequestParam(required=false) String delegatingUserId)
      Retrieve the name of the organization running this platform.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      String description

    • getRegisteredAccessServices

      @GetMapping(path="/registered-services/access-services") public RegisteredOMAGServicesResponse getRegisteredAccessServices(@RequestParam(required=false) String delegatingUserId)
      Return the list of access services that are registered (supported) in this OMAG Server Platform and can be configured for a metadata server.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getRegisteredEngineServices

      @GetMapping(path="/registered-services/engine-services") public RegisteredOMAGServicesResponse getRegisteredEngineServices(@RequestParam(required=false) String delegatingUserId)
      Return the list of engine services that are implemented in this OMAG Server Platform and can be configured for an engine host server.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getRegisteredViewServices

      @GetMapping(path="/registered-services/view-services") public RegisteredOMAGServicesResponse getRegisteredViewServices(@RequestParam(required=false) String delegatingUserId)
      Return the list of view services that are registered (supported) in this OMAG Server Platform and can be configured for a view server.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getRegisteredGovernanceServices

      @GetMapping(path="/registered-services/governance-services") public RegisteredOMAGServicesResponse getRegisteredGovernanceServices(@RequestParam(required=false) 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

      @GetMapping(path="/registered-services/common-services") public RegisteredOMAGServicesResponse getRegisteredCommonServices(@RequestParam(required=false) String delegatingUserId)
      Return the list of common services that are registered (supported) in this OMAG Server Platform and can be configured as part of any server.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getAllRegisteredServices

      @GetMapping(path="/registered-services") public RegisteredOMAGServicesResponse getAllRegisteredServices(@RequestParam(required=false) String delegatingUserId)
      Return the list of all services that are supported in this OMAG Server Platform.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      list of service descriptions

    • getConnectorType

      @GetMapping(path="/connector-types/{connectorProviderClassName}") public OCFConnectorTypeResponse getConnectorType(@PathVariable String connectorProviderClassName, @RequestParam(required=false) 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:
      connectorProviderClassName - name of the connector provider class
      delegatingUserId - external userId making request
      Returns:
      ConnectorType bean or exceptions that occur when trying to create the connector

    • isServerKnown

      @GetMapping(path="/servers/{serverName}/is-known") public BooleanResponse isServerKnown(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return a flag to indicate if this server has ever run on this OMAG Server Platform instance.
      Parameters:
      serverName - server of interest
      delegatingUserId - external userId making request
      Returns:
      flag

    • getKnownServerList

      @GetMapping(path="/servers") public ServerListResponse getKnownServerList(@RequestParam(required=false) 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

      @GetMapping(path="/servers/active") public ServerListResponse getActiveServerList(@RequestParam(required=false) 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

      @GetMapping(path="/servers/{serverName}/status") public ServerStatusResponse getServerStatus(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return information about when the server has been active.
      Parameters:
      serverName - name of the server of interest
      delegatingUserId - external userId making request
      Returns:
      details of the server status

    • getActiveServicesForServer

      @GetMapping(path="/servers/{serverName}/services") public ServerServicesListResponse getActiveServicesForServer(@PathVariable String serverName, @RequestParam(required=false) String delegatingUserId)
      Return the list of services that are active on a specific OMAG Server that is active on this OMAG Server Platform.
      Parameters:
      serverName - name of the server of interest
      delegatingUserId - external userId making request
      Returns:
      server name and list od services running within