DinoViewRESTServices (dino-view-server 2.8 API)

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.

Field Summary

Fields
Modifier and Type Field and Description

protected static DinoViewInstanceHandler instanceHandler

Fields
Modifier and Type	Field and Description
`protected static DinoViewInstanceHandler`	`instanceHandler`

Constructor Summary

Constructors
Constructor and Description

DinoViewRESTServices()
Default constructor

Constructors
Constructor and Description
`DinoViewRESTServices()` Default constructor

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instanceHandler

protected static DinoViewInstanceHandler instanceHandler

Constructor Detail
- DinoViewRESTServices
```
public DinoViewRESTServices()
```
  Default constructor

Method Detail

getResourceEndpointList

public 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 DinoPlatformOverviewResponse platformGetOverview(String serverName,
                                                        String userId,
                                                        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 DinoStringResponse platformGetOrigin(String serverName,
                                            String userId,
                                            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 DinoServerListResponse platformGetActiveServers(String serverName,
                                                       String userId,
                                                       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 DinoServerListResponse platformGetKnownServers(String serverName,
                                                      String userId,
                                                      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 DinoServiceListResponse platformGetAccessServices(String serverName,
                                                         String userId,
                                                         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 DinoServiceListResponse platformGetViewServices(String serverName,
                                                       String userId,
                                                       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 DinoServiceListResponse platformGetGovernanceServices(String serverName,
                                                             String userId,
                                                             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 DinoServiceListResponse platformGetCommonServices(String serverName,
                                                         String userId,
                                                         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 DinoServerOverviewResponse serverGetOverview(String serverName,
                                                    String userId,
                                                    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 DinoStringResponse serverGetOrigin(String serverName,
                                          String userId,
                                          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 DinoServerTypeResponse serverGetTypeClassification(String serverName,
                                                          String userId,
                                                          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 DinoServerConfigResponse serverGetStoredConfiguration(String serverName,
                                                             String userId,
                                                             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 DinoServerConfigResponse serverGetInstanceConfiguration(String serverName,
                                                               String userId,
                                                               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 DinoServerDoubleConfigResponse serverGetStoredAndActiveConfiguration(String serverName,
                                                                            String userId,
                                                                            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 DinoServerAuditLogResponse serverGetAuditLog(String serverName,
                                                    String userId,
                                                    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 DinoServiceListResponse serverGetIntegrationServices(String serverName,
                                                            String userId,
                                                            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 DinoServiceListResponse serverGetEngineServices(String serverName,
                                                       String userId,
                                                       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 DinoServiceListResponse serverGetAccessServices(String serverName,
                                                       String userId,
                                                       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 DinoServiceListResponse serverGetViewServices(String serverName,
                                                     String userId,
                                                     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 DinoServiceDetailsResponse serverGetIntegrationServiceDetails(String serverName,
                                                                     String userId,
                                                                     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 DinoServiceDetailsResponse serverGetEngineServiceDetails(String serverName,
                                                                String userId,
                                                                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 DinoServiceDetailsResponse serverGetAccessServiceDetails(String serverName,
                                                                String userId,
                                                                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 DinoServiceDetailsResponse serverGetViewServiceDetails(String serverName,
                                                              String userId,
                                                              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 DinoEngineDetailsResponse serverGetEngineDetails(String serverName,
                                                        String userId,
                                                        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.

Class DinoViewRESTServices

Field Summary

Constructor Summary