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

Class DinoViewRESTResource

  • @RestController
@RequestMapping("/servers/{viewServerName}/open-metadata/view-services/dino/users/{userId}")
public class DinoViewRESTResource
extends Object
    The DinoViewRESTResource provides the Spring API endpoints of the Dino Open Metadata View Service (OMVS). This interface provides an interfaces for Egeria operators.

    • Constructor Detail

      • DinoViewRESTResource

        public DinoViewRESTResource()
        Default constructor

    • Method Detail

      • getResourceEndpoints

        @GetMapping("/resource-endpoints")
public DinoResourceEndpointListResponse getResourceEndpoints​(@PathVariable
                                                             String viewServerName,
                                                             @PathVariable
                                                             String userId)
        Get the configured resource endpoints
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        Returns:
        response object containing the list of resource endpoints or exception information

      • getPlatformOverview

        @PostMapping("/platform/{platformName}")
public DinoPlatformOverviewResponse getPlatformOverview​(@PathVariable
                                                        String viewServerName,
                                                        @PathVariable
                                                        String userId,
                                                        @PathVariable
                                                        String platformName,
                                                        @RequestBody
                                                        DinoPlatformRequestBody requestBody)
        Get the platform overview
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        platformName - name of the platform
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the overview of the platform or exception information

      • getPlatformOrigin

        @PostMapping("/platform/{platformName}/origin")
public DinoStringResponse getPlatformOrigin​(@PathVariable
                                            String viewServerName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String platformName,
                                            @RequestBody
                                            DinoPlatformRequestBody requestBody)
        Get the platform origin
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        platformName - name of the platform
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the platform's origin string or exception information

      • getActiveServers

        @PostMapping("/platform/{platformName}/servers/active")
public DinoServerListResponse getActiveServers​(@PathVariable
                                               String viewServerName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String platformName,
                                               @RequestBody
                                               DinoPlatformRequestBody requestBody)
        Get the active servers on a platform
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        platformName - name of the platform
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of names of active servers or exception information

      • getKnownServers

        @PostMapping("/platform/{platformName}/servers")
public DinoServerListResponse getKnownServers​(@PathVariable
                                              String viewServerName,
                                              @PathVariable
                                              String userId,
                                              @PathVariable
                                              String platformName,
                                              @RequestBody
                                              DinoPlatformRequestBody requestBody)
        Get the known servers on a platform
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        platformName - name of the platform
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of names of all known servers or exception information

      • getAccessServices

        @PostMapping("/platform/{platformName}/registered-services/access-services")
public DinoServiceListResponse getAccessServices​(@PathVariable
                                                 String viewServerName,
                                                 @PathVariable
                                                 String userId,
                                                 @PathVariable
                                                 String platformName,
                                                 @RequestBody
                                                 DinoPlatformRequestBody requestBody)
        Get the access services on a platform
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        platformName - name of the platform
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of service objects or exception information

      • getViewServices

        @PostMapping("/platform/{platformName}/registered-services/view-services")
public DinoServiceListResponse getViewServices​(@PathVariable
                                               String viewServerName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String platformName,
                                               @RequestBody
                                               DinoPlatformRequestBody requestBody)
        Get the view services on a platform
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        platformName - name of the platform
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of service objects or exception information

      • getGovernanceServices

        @PostMapping("/platform/{platformName}/registered-services/governance-services")
public DinoServiceListResponse getGovernanceServices​(@PathVariable
                                                     String viewServerName,
                                                     @PathVariable
                                                     String userId,
                                                     @PathVariable
                                                     String platformName,
                                                     @RequestBody
                                                     DinoPlatformRequestBody requestBody)
        Get the governance services on a platform
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        platformName - name of the platform
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of service objects or exception information

      • getCommonServices

        @PostMapping("/platform/{platformName}/registered-services/common-services")
public DinoServiceListResponse getCommonServices​(@PathVariable
                                                 String viewServerName,
                                                 @PathVariable
                                                 String userId,
                                                 @PathVariable
                                                 String platformName,
                                                 @RequestBody
                                                 DinoPlatformRequestBody requestBody)
        Get the common services on a platform
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        platformName - name of the platform
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of service objects or exception information

      • getServerOverview

        @PostMapping("/server/{serverName}")
public DinoServerOverviewResponse getServerOverview​(@PathVariable
                                                    String viewServerName,
                                                    @PathVariable
                                                    String userId,
                                                    @PathVariable
                                                    String serverName,
                                                    @RequestBody
                                                    DinoServerRequestBody requestBody)
        Get the server overview
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the overview of the server or exception information

      • getServerOrigin

        @PostMapping("/server/{serverName}/origin")
public DinoStringResponse getServerOrigin​(@PathVariable
                                          String viewServerName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          String serverName,
                                          @RequestBody
                                          DinoServerRequestBody requestBody)
        Get the server origin
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the server origin or exception information

      • getServerTypeClassification

        @PostMapping("/server/{serverName}/server-type-classification")
public DinoServerTypeResponse getServerTypeClassification​(@PathVariable
                                                          String viewServerName,
                                                          @PathVariable
                                                          String userId,
                                                          @PathVariable
                                                          String serverName,
                                                          @RequestBody
                                                          DinoServerRequestBody requestBody)
        Get the server type classification
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the server type information or exception information

      • getServerStoredConfiguration

        @PostMapping("/server/{serverName}/configuration")
public DinoServerConfigResponse getServerStoredConfiguration​(@PathVariable
                                                             String viewServerName,
                                                             @PathVariable
                                                             String userId,
                                                             @PathVariable
                                                             String serverName,
                                                             @RequestBody
                                                             DinoServerRequestBody requestBody)
        Get the server's stored configuration
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the server configuration or exception information

      • getServerInstanceConfiguration

        @PostMapping("/server/{serverName}/instance/configuration")
public DinoServerConfigResponse getServerInstanceConfiguration​(@PathVariable
                                                               String viewServerName,
                                                               @PathVariable
                                                               String userId,
                                                               @PathVariable
                                                               String serverName,
                                                               @RequestBody
                                                               DinoServerRequestBody requestBody)
        Get the server's active (running instance) configuration
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the server configuration or exception information

      • getServerStoredAndActiveConfiguration

        @PostMapping("/server/{serverName}/stored-and-active-configuration")
public DinoServerDoubleConfigResponse getServerStoredAndActiveConfiguration​(@PathVariable
                                                                            String viewServerName,
                                                                            @PathVariable
                                                                            String userId,
                                                                            @PathVariable
                                                                            String serverName,
                                                                            @RequestBody
                                                                            DinoServerRequestBody requestBody)
        Get the server's stored and active (running instance) configurations in a duplexed response
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the server configuration or exception information

      • getServerAuditLog

        @PostMapping("/server/{serverName}/audit-log")
public DinoServerAuditLogResponse getServerAuditLog​(@PathVariable
                                                    String viewServerName,
                                                    @PathVariable
                                                    String userId,
                                                    @PathVariable
                                                    String serverName,
                                                    @RequestBody
                                                    DinoServerRequestBody requestBody)
        Get the server's audit log
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the server's audit log or exception information

      • getServerIntegrationServices

        @PostMapping("/server/{serverName}/integration-services")
public DinoServiceListResponse getServerIntegrationServices​(@PathVariable
                                                            String viewServerName,
                                                            @PathVariable
                                                            String userId,
                                                            @PathVariable
                                                            String serverName,
                                                            @RequestBody
                                                            DinoServiceRequestBody requestBody)
        Get a list of the integration services on the server
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of integration services or exception information

      • getServerEngineServices

        @PostMapping("/server/{serverName}/engine-services")
public DinoServiceListResponse getServerEngineServices​(@PathVariable
                                                       String viewServerName,
                                                       @PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String serverName,
                                                       @RequestBody
                                                       DinoServiceRequestBody requestBody)
        Get a list of the engine services on the server
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of integration services or exception information

      • getServerAccessServices

        @PostMapping("/server/{serverName}/access-services")
public DinoServiceListResponse getServerAccessServices​(@PathVariable
                                                       String viewServerName,
                                                       @PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String serverName,
                                                       @RequestBody
                                                       DinoServiceRequestBody requestBody)
        Get a list of the access services on the server
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of integration services or exception information

      • getServerViewServices

        @PostMapping("/server/{serverName}/view-services")
public DinoServiceListResponse getServerViewServices​(@PathVariable
                                                     String viewServerName,
                                                     @PathVariable
                                                     String userId,
                                                     @PathVariable
                                                     String serverName,
                                                     @RequestBody
                                                     DinoServiceRequestBody requestBody)
        Get a list of the view services on the server
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the list of integration services or exception information

      • getServerIntegrationServiceDetails

        @PostMapping("/server/{serverName}/integration-service-details")
public DinoServiceDetailsResponse getServerIntegrationServiceDetails​(@PathVariable
                                                                     String viewServerName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @PathVariable
                                                                     String serverName,
                                                                     @RequestBody
                                                                     DinoServiceRequestBody requestBody)
        Get the details of an integration service running on the server
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the service's details or exception information

      • getServerEngineServiceDetails

        @PostMapping("/server/{serverName}/engine-service-details")
public DinoServiceDetailsResponse getServerEngineServiceDetails​(@PathVariable
                                                                String viewServerName,
                                                                @PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                String serverName,
                                                                @RequestBody
                                                                DinoServiceRequestBody requestBody)
        Get the details of an engine service running on the server
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the service's details or exception information

      • getServerAccessServiceDetails

        @PostMapping("/server/{serverName}/access-service-details")
public DinoServiceDetailsResponse getServerAccessServiceDetails​(@PathVariable
                                                                String viewServerName,
                                                                @PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                String serverName,
                                                                @RequestBody
                                                                DinoServiceRequestBody requestBody)
        Get the details of an access service running on the server
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the service's details or exception information

      • getServerViewServiceDetails

        @PostMapping("/server/{serverName}/view-service-details")
public DinoServiceDetailsResponse getServerViewServiceDetails​(@PathVariable
                                                              String viewServerName,
                                                              @PathVariable
                                                              String userId,
                                                              @PathVariable
                                                              String serverName,
                                                              @RequestBody
                                                              DinoServiceRequestBody requestBody)
        Get the details of a view service running on the server
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the service's details or exception information

      • getServerEngineServiceDetails

        @PostMapping("/server/{serverName}/engine-details")
public DinoEngineDetailsResponse getServerEngineServiceDetails​(@PathVariable
                                                               String viewServerName,
                                                               @PathVariable
                                                               String userId,
                                                               @PathVariable
                                                               String serverName,
                                                               @RequestBody
                                                               DinoEngineRequestBody requestBody)
        Get the details of an engine running on the server. This wll return a list of the services registered to the engine The request body contains the serverName, platformName and OMES service name, plus the engine name.
        Parameters:
        viewServerName - name of the server running the view-service.
        userId - user account under which to conduct operation.
        serverName - name of the server
        requestBody - request body containing parameters to formulate repository request
        Returns:
        response object containing the service's details or exception information