org.odpi.openmetadata.viewservices.dino.server

Class DinoViewRESTResource

java.lang.Object

org.odpi.openmetadata.viewservices.dino.server.DinoViewRESTResource

@RestController
 @RequestMapping(value="/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 Summary

Constructors

Constructor and Description
DinoViewRESTResource() Default constructor

Method Summary

Modifier and Type	Method and Description
DinoServiceListResponse	getAccessServices(String viewServerName, String userId, String platformName, DinoPlatformRequestBody requestBody) Get the access services on a platform
DinoServerListResponse	getActiveServers(String viewServerName, String userId, String platformName, DinoPlatformRequestBody requestBody) Get the active servers on a platform
DinoServiceListResponse	getCommonServices(String viewServerName, String userId, String platformName, DinoPlatformRequestBody requestBody) Get the common services on a platform
DinoServiceListResponse	getGovernanceServices(String viewServerName, String userId, String platformName, DinoPlatformRequestBody requestBody) Get the governance services on a platform
DinoServerListResponse	getKnownServers(String viewServerName, String userId, String platformName, DinoPlatformRequestBody requestBody) Get the known servers on a platform
DinoStringResponse	getPlatformOrigin(String viewServerName, String userId, String platformName, DinoPlatformRequestBody requestBody) Get the platform origin
DinoPlatformOverviewResponse	getPlatformOverview(String viewServerName, String userId, String platformName, DinoPlatformRequestBody requestBody) Get the platform overview
DinoResourceEndpointListResponse	getResourceEndpoints(String viewServerName, String userId) Get the configured resource endpoints
DinoServerAuditLogResponse	getServerAuditLog(String viewServerName, String userId, String serverName, DinoServerRequestBody requestBody) Get the server's audit log
DinoServerConfigResponse	getServerInstanceConfiguration(String viewServerName, String userId, String serverName, DinoServerRequestBody requestBody) Get the server's active (running instance) configuration
DinoStringResponse	getServerOrigin(String viewServerName, String userId, String serverName, DinoServerRequestBody requestBody) Get the server origin
DinoServerOverviewResponse	getServerOverview(String viewServerName, String userId, String serverName, DinoServerRequestBody requestBody) Get the server overview
DinoServerDoubleConfigResponse	getServerStoredAndActiveConfiguration(String viewServerName, String userId, String serverName, DinoServerRequestBody requestBody) Get the server's stored and active (running instance) configurations in a duplexed response
DinoServerConfigResponse	getServerStoredConfiguration(String viewServerName, String userId, String serverName, DinoServerRequestBody requestBody) Get the server's stored configuration
DinoServerTypeResponse	getServerTypeClassification(String viewServerName, String userId, String serverName, DinoServerRequestBody requestBody) Get the server type classification
DinoServiceListResponse	getViewServices(String viewServerName, String userId, String platformName, DinoPlatformRequestBody requestBody) Get the view services on a platform

Methods inherited from class java.lang.Object

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

Constructor Detail

DinoViewRESTResource

public DinoViewRESTResource()

Default constructor

Method Detail

getResourceEndpoints

@GetMapping(value="/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(value="/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(value="/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(value="/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(value="/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(value="/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(value="/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(value="/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(value="/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(value="/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(value="/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 repository's type information or exception information

getServerTypeClassification

@PostMapping(value="/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 (as a String) or exception information

getServerStoredConfiguration

@PostMapping(value="/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 repository's type information or exception information

getServerInstanceConfiguration

@PostMapping(value="/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 repository's type information or exception information

getServerStoredAndActiveConfiguration

@PostMapping(value="/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 repository's type information or exception information

getServerAuditLog

@PostMapping(value="/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 repository's type information or exception information