Package org.odpi.openmetadata.viewservices.dino.server

Class DinoViewRESTServices

java.lang.Object
org.odpi.openmetadata.viewservices.dino.server.DinoViewRESTServices
public class DinoViewRESTServices extends Object
The DinoViewRESTServices provides the implementation of the Dino Open Metadata View Service (OMVS). This interface provides view interfaces for infrastructure and ops users.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DinoViewRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoResourceEndpointListResponse
    getResourceEndpointList(String serverName, String userId)
    Retrieve platform origin
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse
    platformGetAccessServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
    Retrieve access services for platform
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerListResponse
    platformGetActiveServers(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
    Retrieve active servers for platform
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse
    platformGetCommonServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
    Retrieve common services for platform
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse
    platformGetGovernanceServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
    Retrieve governance services for platform
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerListResponse
    platformGetKnownServers(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
    Retrieve known servers for platform
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoStringResponse
    platformGetOrigin(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
    Retrieve platform origin
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformOverviewResponse
    platformGetOverview(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
    Retrieve platform overview - this is an overview of multiple aspects of the platform for when it becomes the focus.
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse
    platformGetViewServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
    Retrieve view services for platform
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceDetailsResponse
    serverGetAccessServiceDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
    Retrieve service details for a specified access service
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse
    serverGetAccessServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
    Retrieve list of access services for a specified server
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerAuditLogResponse
    serverGetAuditLog(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
    Retrieve server's audit log
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoEngineDetailsResponse
    serverGetEngineDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoEngineRequestBody requestBody)
    Retrieve engine details for a specified engine
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceDetailsResponse
    serverGetEngineServiceDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
    Retrieve service details for a specified engine service
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse
    serverGetEngineServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
    Retrieve list of engine services for a specified server
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerConfigResponse
    serverGetInstanceConfiguration(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
    Retrieve server's running instance configuration
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceDetailsResponse
    serverGetIntegrationServiceDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
    Retrieve service details for a specified integration service
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse
    serverGetIntegrationServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
    Retrieve list of integration services for a specified server
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoStringResponse
    serverGetOrigin(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
    Retrieve server origin
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerOverviewResponse
    serverGetOverview(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
    Retrieve server overview - this is an overview of multiple aspects of the server for when it becomes the focus.
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerDoubleConfigResponse
    serverGetStoredAndActiveConfiguration(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
    Retrieve server's running instance configuration
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerConfigResponse
    serverGetStoredConfiguration(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
    Retrieve server's stored configuration
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerTypeResponse
    serverGetTypeClassification(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
    Retrieve server type classification
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceDetailsResponse
    serverGetViewServiceDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
    Retrieve service details for a specified view service
    org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse
    serverGetViewServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
    Retrieve list of view services for a specified server

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DinoViewRESTServices

      public DinoViewRESTServices()
      Default constructor

  • Method Details

    • getResourceEndpointList

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoResourceEndpointListResponse getResourceEndpointList(String serverName, String userId)
      Retrieve platform origin
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      Returns:
      response the list of resource endpoints configured for the view service

    • platformGetOverview

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformOverviewResponse platformGetOverview(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
      Retrieve platform overview - this is an overview of multiple aspects of the platform for when it becomes the focus.
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing platformName of the platform to be queried.
      Returns:
      response the platform overview.

    • platformGetOrigin

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoStringResponse platformGetOrigin(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
      Retrieve platform origin
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing platformName of the platform to be queried.
      Returns:
      response the origin string for the platform.

    • platformGetActiveServers

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerListResponse platformGetActiveServers(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
      Retrieve active servers for platform
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing platformName and platformRootURL of the platform to be queried.
      Returns:
      response the list of servers that are active on the platform

    • platformGetKnownServers

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerListResponse platformGetKnownServers(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
      Retrieve known servers for platform
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing platformName and platformRootURL of the platform to be queried.
      Returns:
      response the list of servers that are active on the platform

    • platformGetAccessServices

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse platformGetAccessServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
      Retrieve access services for platform
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing platformName and platformRootURL of the platform to be queried.
      Returns:
      response the list of services registered to the platform

    • platformGetViewServices

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse platformGetViewServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
      Retrieve view services for platform
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing platformName and platformRootURL of the platform to be queried.
      Returns:
      response the list of services registered to the platform

    • platformGetGovernanceServices

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse platformGetGovernanceServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
      Retrieve governance services for platform
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing platformName and platformRootURL of the platform to be queried.
      Returns:
      response the list of services registered to the platform

    • platformGetCommonServices

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse platformGetCommonServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoPlatformRequestBody requestBody)
      Retrieve common services for platform
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing platformName and platformRootURL of the platform to be queried.
      Returns:
      response the list of services registered to the platform

    • serverGetOverview

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerOverviewResponse serverGetOverview(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
      Retrieve server overview - this is an overview of multiple aspects of the server for when it becomes the focus.
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server to be queried.
      Returns:
      response the server overview.

    • serverGetOrigin

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoStringResponse serverGetOrigin(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
      Retrieve server origin
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server to be queried.
      Returns:
      response the origin string for the server.

    • serverGetTypeClassification

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerTypeResponse serverGetTypeClassification(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
      Retrieve server type classification
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server to be queried.
      Returns:
      response the server type, as a string response.

    • serverGetStoredConfiguration

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerConfigResponse serverGetStoredConfiguration(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
      Retrieve server's stored configuration
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server to be queried.
      Returns:
      response the configuration for the server.

    • serverGetInstanceConfiguration

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerConfigResponse serverGetInstanceConfiguration(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
      Retrieve server's running instance configuration
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server to be queried.
      Returns:
      response the configuration for the server.

    • serverGetStoredAndActiveConfiguration

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerDoubleConfigResponse serverGetStoredAndActiveConfiguration(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
      Retrieve server's running instance configuration
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server to be queried.
      Returns:
      response the configuration for the server.

    • serverGetAuditLog

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerAuditLogResponse serverGetAuditLog(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServerRequestBody requestBody)
      Retrieve server's audit log
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server to be queried.
      Returns:
      response the configuration for the server.

    • serverGetIntegrationServices

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse serverGetIntegrationServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
      Retrieve list of integration services for a specified server
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.

    • serverGetEngineServices

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse serverGetEngineServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
      Retrieve list of engine services for a specified server
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.

    • serverGetAccessServices

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse serverGetAccessServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
      Retrieve list of access services for a specified server
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.

    • serverGetViewServices

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceListResponse serverGetViewServices(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
      Retrieve list of view services for a specified server
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.

    • serverGetIntegrationServiceDetails

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceDetailsResponse serverGetIntegrationServiceDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
      Retrieve service details for a specified integration service
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.

    • serverGetEngineServiceDetails

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceDetailsResponse serverGetEngineServiceDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
      Retrieve service details for a specified engine service
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.

    • serverGetAccessServiceDetails

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceDetailsResponse serverGetAccessServiceDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
      Retrieve service details for a specified access service
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.

    • serverGetViewServiceDetails

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceDetailsResponse serverGetViewServiceDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoServiceRequestBody requestBody)
      Retrieve service details for a specified view service
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.

    • serverGetEngineDetails

      public org.odpi.openmetadata.viewservices.dino.api.rest.DinoEngineDetailsResponse serverGetEngineDetails(String serverName, String userId, org.odpi.openmetadata.viewservices.dino.api.rest.DinoEngineRequestBody requestBody)
      Retrieve engine details for a specified engine
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - body containing serverName of the server and serviceName of the service to be queried.
      Returns:
      response the configuration for the server.