Package org.odpi.openmetadata.viewservices.dino.handlers

Class DinoViewHandler

java.lang.Object

org.odpi.openmetadata.viewservices.dino.handlers.DinoViewHandler

public class DinoViewHandler
extends Object

The DinoViewHandler is initialised with the configured resource endpoints. The handler exposes methods for functionality for the dino view

Constructor Summary

Constructors

Constructor	Description
DinoViewHandler()	Default constructor for DinoViewHandler
DinoViewHandler(List<ResourceEndpointConfig> resourceEndpoints)	Constructor for DinoViewHandler with configured resourceEndpoints

Method Summary

Modifier and Type	Method	Description
Map<String,List<ResourceEndpoint>>	getResourceEndpoints(String userId, String methodName)	getResourceEndpoints - returns a list of the configured resource endpoints.
List<RegisteredOMAGService>	platformGetAccessServiceList(String userId, String platformName, String methodName)
List<DinoServerInstance>	platformGetActiveServerList(String userId, String platformName, String methodName)
List<RegisteredOMAGService>	platformGetCommonServiceList(String userId, String platformName, String methodName)
List<RegisteredOMAGService>	platformGetGovernanceServiceList(String userId, String platformName, String methodName)
List<DinoServerInstance>	platformGetKnownServerList(String userId, String platformName, String methodName)
String	platformGetOrigin(String userId, String platformName, String methodName)
PlatformOverview	platformGetOverview(String userId, String platformName, String methodName)
List<RegisteredOMAGService>	platformGetViewServiceList(String userId, String platformName, String methodName)
ServiceDetails	serverGetAccessServiceDetails(String userId, String serverName, String platformName, String serviceFullName, String serviceURLMarker, String methodName)
List<RegisteredOMAGService>	serverGetAccessServices(String userId, String serverName, String platformName, String methodName)
OMRSAuditLogReport	serverGetAuditLog(String userId, String serverName, String platformName, String methodName)
Map<String,ServerCohortDetails>	serverGetCohortDetails(String userId, String serverName, String platformName, String methodName)	Retrieve the server's cohort descriptions and the local and remote registrations for each cohort
EngineDetails	serverGetEngineDetails(String userId, String serverName, String platformName, String engineQualifiedName, String methodName)
ServiceDetails	serverGetEngineServiceDetails(String userId, String serverName, String platformName, String serviceURLMarker, String methodName)
List<RegisteredOMAGService>	serverGetEngineServices(String userId, String serverName, String platformName, String methodName)
OMAGServerConfig	serverGetInstanceConfiguration(String userId, String serverName, String platformName, String methodName)
ServiceDetails	serverGetIntegrationServiceDetails(String userId, String serverName, String platformName, String serviceURLMarker, String methodName)
List<RegisteredOMAGService>	serverGetIntegrationServices(String userId, String serverName, String platformName, String methodName)
String	serverGetOrigin(String userId, String serverName, String platformName, String methodName)
ServerOverview	serverGetOverview(String userId, String serverName, String platformName, String serverInstanceName, String description, String methodName)
OMAGServerConfig	serverGetStoredConfiguration(String userId, String serverName, String platformName, String methodName)
ServerTypeClassificationSummary	serverGetTypeClassification(String userId, String serverName, String platformName, String methodName)
ServiceDetails	serverGetViewServiceDetails(String userId, String serverName, String platformName, String serviceURLMarker, String methodName)
List<RegisteredOMAGService>	serverGetViewServices(String userId, String serverName, String platformName, String methodName)

Methods inherited from class java.lang.Object

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

Constructor Detail

DinoViewHandler

public DinoViewHandler()

Default constructor for DinoViewHandler

DinoViewHandler

public DinoViewHandler(List<ResourceEndpointConfig> resourceEndpoints)

Constructor for DinoViewHandler with configured resourceEndpoints

Parameters:

resourceEndpoints - - list of resource endpoint configuration objects for this view service

Method Detail

getResourceEndpoints

public Map<String,List<ResourceEndpoint>> getResourceEndpoints(String userId,
                                                                     String methodName)

getResourceEndpoints - returns a list of the configured resource endpoints. Does not include discovered resource endpoints.

Parameters:

userId - userId under which the request is performed

methodName - The name of the method being invoked

Returns:

The resource endpoints that have been configured for the view service

platformGetOverview

public PlatformOverview platformGetOverview(String userId,
                                            String platformName,
                                            String methodName)
                                     throws DinoViewServiceException

Throws:

DinoViewServiceException

platformGetOrigin

public String platformGetOrigin(String userId,
                                String platformName,
                                String methodName)
                         throws DinoViewServiceException

Throws:

DinoViewServiceException

platformGetActiveServerList

public List<DinoServerInstance> platformGetActiveServerList(String userId,
                                                            String platformName,
                                                            String methodName)
                                                     throws DinoViewServiceException

Throws:

DinoViewServiceException

platformGetKnownServerList

public List<DinoServerInstance> platformGetKnownServerList(String userId,
                                                           String platformName,
                                                           String methodName)
                                                    throws DinoViewServiceException

Throws:

DinoViewServiceException

platformGetAccessServiceList

public List<RegisteredOMAGService> platformGetAccessServiceList(String userId,
                                                                String platformName,
                                                                String methodName)
                                                         throws DinoViewServiceException

Throws:

DinoViewServiceException

platformGetViewServiceList

public List<RegisteredOMAGService> platformGetViewServiceList(String userId,
                                                              String platformName,
                                                              String methodName)
                                                       throws DinoViewServiceException

Throws:

DinoViewServiceException

platformGetGovernanceServiceList

public List<RegisteredOMAGService> platformGetGovernanceServiceList(String userId,
                                                                    String platformName,
                                                                    String methodName)
                                                             throws DinoViewServiceException

Throws:

DinoViewServiceException

platformGetCommonServiceList

public List<RegisteredOMAGService> platformGetCommonServiceList(String userId,
                                                                String platformName,
                                                                String methodName)
                                                         throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetOverview

public ServerOverview serverGetOverview(String userId,
                                        String serverName,
                                        String platformName,
                                        String serverInstanceName,
                                        String description,
                                        String methodName)
                                 throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetOrigin

public String serverGetOrigin(String userId,
                              String serverName,
                              String platformName,
                              String methodName)
                       throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetTypeClassification

public ServerTypeClassificationSummary serverGetTypeClassification(String userId,
                                                                   String serverName,
                                                                   String platformName,
                                                                   String methodName)
                                                            throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetStoredConfiguration

public OMAGServerConfig serverGetStoredConfiguration(String userId,
                                                     String serverName,
                                                     String platformName,
                                                     String methodName)
                                              throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetInstanceConfiguration

public OMAGServerConfig serverGetInstanceConfiguration(String userId,
                                                       String serverName,
                                                       String platformName,
                                                       String methodName)
                                                throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetCohortDetails

public Map<String,ServerCohortDetails> serverGetCohortDetails(String userId,
                                                                    String serverName,
                                                                    String platformName,
                                                                    String methodName)
                                                             throws DinoViewServiceException

Retrieve the server's cohort descriptions and the local and remote registrations for each cohort

Parameters:

userId - userId under which the request is performed

serverName - The name of the server to interrogate

platformName - The name of the platform the server can be reached at

methodName - The name of the method being invoked

Returns:

the server type as a String Exceptions returned by the server

Throws:

DinoViewServiceException - an error was detected and reported

serverGetAuditLog

public OMRSAuditLogReport serverGetAuditLog(String userId,
                                            String serverName,
                                            String platformName,
                                            String methodName)
                                     throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetIntegrationServices

public List<RegisteredOMAGService> serverGetIntegrationServices(String userId,
                                                                String serverName,
                                                                String platformName,
                                                                String methodName)
                                                         throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetEngineServices

public List<RegisteredOMAGService> serverGetEngineServices(String userId,
                                                           String serverName,
                                                           String platformName,
                                                           String methodName)
                                                    throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetAccessServices

public List<RegisteredOMAGService> serverGetAccessServices(String userId,
                                                           String serverName,
                                                           String platformName,
                                                           String methodName)
                                                    throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetViewServices

public List<RegisteredOMAGService> serverGetViewServices(String userId,
                                                         String serverName,
                                                         String platformName,
                                                         String methodName)
                                                  throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetIntegrationServiceDetails

public ServiceDetails serverGetIntegrationServiceDetails(String userId,
                                                         String serverName,
                                                         String platformName,
                                                         String serviceURLMarker,
                                                         String methodName)
                                                  throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetEngineServiceDetails

public ServiceDetails serverGetEngineServiceDetails(String userId,
                                                    String serverName,
                                                    String platformName,
                                                    String serviceURLMarker,
                                                    String methodName)
                                             throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetAccessServiceDetails

public ServiceDetails serverGetAccessServiceDetails(String userId,
                                                    String serverName,
                                                    String platformName,
                                                    String serviceFullName,
                                                    String serviceURLMarker,
                                                    String methodName)
                                             throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetViewServiceDetails

public ServiceDetails serverGetViewServiceDetails(String userId,
                                                  String serverName,
                                                  String platformName,
                                                  String serviceURLMarker,
                                                  String methodName)
                                           throws DinoViewServiceException

Throws:

DinoViewServiceException

serverGetEngineDetails

public EngineDetails serverGetEngineDetails(String userId,
                                            String serverName,
                                            String platformName,
                                            String engineQualifiedName,
                                            String methodName)
                                     throws DinoViewServiceException

Throws:

DinoViewServiceException