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 and Description
DinoViewHandler(List<ResourceEndpointConfig> resourceEndpoints) Constructor for the DinoViewHandler ~Store the configured endpoints

Method Summary

Modifier and Type	Method and 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)
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
OMAGServerConfig	serverGetInstanceConfiguration(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)

Methods inherited from class java.lang.Object

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

Constructor Detail

DinoViewHandler

public DinoViewHandler(List<ResourceEndpointConfig> resourceEndpoints)

Constructor for the DinoViewHandler ~Store the configured endpoints

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 This method will return the resource endpoints that have been configured for the view service

platformGetOverview

public PlatformOverview platformGetOverview(String userId,
                                            String platformName,
                                            String methodName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

platformGetOrigin

public String platformGetOrigin(String userId,
                                String platformName,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

platformGetActiveServerList

public List<DinoServerInstance> platformGetActiveServerList(String userId,
                                                            String platformName,
                                                            String methodName)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

platformGetKnownServerList

public List<DinoServerInstance> platformGetKnownServerList(String userId,
                                                           String platformName,
                                                           String methodName)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

platformGetAccessServiceList

public List<RegisteredOMAGService> platformGetAccessServiceList(String userId,
                                                                String platformName,
                                                                String methodName)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

platformGetViewServiceList

public List<RegisteredOMAGService> platformGetViewServiceList(String userId,
                                                              String platformName,
                                                              String methodName)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

platformGetGovernanceServiceList

public List<RegisteredOMAGService> platformGetGovernanceServiceList(String userId,
                                                                    String platformName,
                                                                    String methodName)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

platformGetCommonServiceList

public List<RegisteredOMAGService> platformGetCommonServiceList(String userId,
                                                                String platformName,
                                                                String methodName)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

serverGetOverview

public ServerOverview serverGetOverview(String userId,
                                        String serverName,
                                        String platformName,
                                        String serverInstanceName,
                                        String description,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException,
                                        RepositoryErrorException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

RepositoryErrorException

serverGetOrigin

public String serverGetOrigin(String userId,
                              String serverName,
                              String platformName,
                              String methodName)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

serverGetTypeClassification

public ServerTypeClassificationSummary serverGetTypeClassification(String userId,
                                                                   String serverName,
                                                                   String platformName,
                                                                   String methodName)
                                                            throws InvalidParameterException,
                                                                   OMAGInvalidParameterException,
                                                                   OMAGNotAuthorizedException,
                                                                   OMAGConfigurationErrorException

Throws:

InvalidParameterException

OMAGInvalidParameterException

OMAGNotAuthorizedException

OMAGConfigurationErrorException

serverGetStoredConfiguration

public OMAGServerConfig serverGetStoredConfiguration(String userId,
                                                     String serverName,
                                                     String platformName,
                                                     String methodName)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

serverGetInstanceConfiguration

public OMAGServerConfig serverGetInstanceConfiguration(String userId,
                                                       String serverName,
                                                       String platformName,
                                                       String methodName)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

serverGetCohortDetails

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

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:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user is not authorized to perform the requested operation

serverGetAuditLog

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

Throws:

UserNotAuthorizedException

InvalidParameterException