Package org.odpi.openmetadata.viewservices.tex.handlers

Class TexViewHandler

java.lang.Object

org.odpi.openmetadata.viewservices.tex.handlers.TexViewHandler

public class TexViewHandler
extends Object

The TexViewHandler is initialised with the server the call should be sent to. The handler exposes methods for functionality for the type explorer view

Constructor Summary

Constructors

Constructor	Description
TexViewHandler()	Default constructor for TexViewHandler
TexViewHandler(List<ResourceEndpointConfig> resourceEndpoints)	TexViewHandler constructor 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.
TypeExplorer	getTypeExplorer(String userId, String repositoryServerName, String platformName, boolean enterpriseOption, boolean deprecationOption, String methodName)	Retrieve type information from the repository server

Methods inherited from class java.lang.Object

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

Constructor Detail

TexViewHandler

public TexViewHandler()

Default constructor for TexViewHandler

TexViewHandler

public TexViewHandler(List<ResourceEndpointConfig> resourceEndpoints)

TexViewHandler constructor 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

getTypeExplorer

public TypeExplorer getTypeExplorer(String userId,
                                    String repositoryServerName,
                                    String platformName,
                                    boolean enterpriseOption,
                                    boolean deprecationOption,
                                    String methodName)
                             throws TexViewServiceException

Retrieve type information from the repository server

Parameters:

userId - userId under which the request is performed

repositoryServerName - The name of the repository server to interrogate

platformName - The name of the platform running the repository server to interrogate

enterpriseOption - Whether the query is at cohort level or server specific

deprecationOption - only include deprecated types if this option is true

methodName - The name of the method being invoked

Returns:

response containing the TypeExplorer object. Exceptions

Throws:

TexViewServiceException - an error was detected and details are reported in the exception