Package org.odpi.openmetadata.accessservices.glossaryview.client

Class GlossaryViewClient

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.accessservices.glossaryview.client.GlossaryViewClient

public class GlossaryViewClient
extends FFDCRESTClient

The Glossary View Open Metadata Access Service (OMAS) provides an interface to query for glossaries, categories and terms. Regarding the paged requests, one can pass null to 'from' and 'size' params in order to use their default values

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
GlossaryViewClient(String serverName, String serverPlatformRootURL)	Create a new client
GlossaryViewClient(String serverName, String serverPlatformRootURL, String userId, String password)	Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
List<GlossaryCategory>	getAllCategories(String userId, Integer from, Integer size)	Extract all categories definitions
List<Glossary>	getAllGlossaries(String userId, Integer from, Integer size)	Extract all glossary definitions
List<GlossaryTerm>	getAllGlossaryTerms(String userId, Integer from, Integer size)	Extract all glossaryTerms definitions
List<GlossaryTerm>	getAntonyms(String userId, String termGUID, Integer from, Integer size)	Extract antonyms
List<GlossaryTerm>	getAssignedElements(String userId, String termGUID, Integer from, Integer size)	Extract assigned elements
List<GlossaryTerm>	getAttributes(String userId, String termGUID, Integer from, Integer size)	Extract attributes
List<GlossaryCategory>	getCategories(String userId, String glossaryGUID, Integer from, Integer size)	Extract categories within a glossary
GlossaryCategory	getCategory(String userId, String categoryGUID)	Extract a category definition
Glossary	getCategoryHomeGlossary(String userId, String categoryGUID)	Extract a category's home glossary
List<ExternalGlossaryLink>	getExternalGlossaryLinksOfCategory(String userId, String categoryGUID, Integer from, Integer size)	Extract a category's external glossary links
List<ExternalGlossaryLink>	getExternalGlossaryLinksOfGlossary(String userId, String glossaryGUID, Integer from, Integer size)	Extract a glossaries's external glossary links
List<ExternalGlossaryLink>	getExternalGlossaryLinksOfTerm(String userId, String termGUID, Integer from, Integer size)	Extract a term's external glossary links
Glossary	getGlossary(String userId, String glossaryGUID)	Extract a glossary definition
List<GlossaryTerm>	getIsA(String userId, String termGUID, Integer from, Integer size)	Extract "is-a" terms
protected GlossaryViewEntityDetailResponse	getMultipleEntitiesPagedResponse(String methodName, String path, String serverName, String userId, Integer from, Integer size)
protected GlossaryViewEntityDetailResponse	getMultipleRelatedEntitiesPagedResponse(String methodName, String path, String serverName, String userId, String entityGUID, Integer from, Integer size)
List<GlossaryTerm>	getPreferredTerms(String userId, String termGUID, Integer from, Integer size)	Extract preferred terms
List<GlossaryTerm>	getRelatedTerms(String userId, String termGUID, Integer from, Integer size)	Extract related terms
List<GlossaryTerm>	getReplacementTerms(String userId, String termGUID, Integer from, Integer size)	Extract replacement terms
protected GlossaryViewEntityDetailResponse	getSingleEntityResponse(String methodName, String path, String serverName, String userId, String entityGUID)
List<GlossaryCategory>	getSubcategories(String userId, String categoryGUID, Integer from, Integer size)	Extract subcategories of a category
List<GlossaryTerm>	getSubtypes(String userId, String termGUID, Integer from, Integer size)	Extract subtypes
List<GlossaryTerm>	getSynonyms(String userId, String termGUID, Integer from, Integer size)	Extract synonyms
GlossaryTerm	getTerm(String userId, String termGUID)	Extract a term definition
Glossary	getTermHomeGlossary(String userId, String termGUID)	Extract a term's home glossary
List<GlossaryTerm>	getTermsOfCategory(String userId, String categoryGUID, Integer from, Integer size)	Extract terms within a category
List<GlossaryTerm>	getTermsOfGlossary(String userId, String glossaryGUID, Integer from, Integer size)	Extract terms within a glossary
List<GlossaryTerm>	getTranslations(String userId, String termGUID, Integer from, Integer size)	Extract translations
List<GlossaryTerm>	getTypes(String userId, String termGUID, Integer from, Integer size)	Extract types
List<GlossaryTerm>	getUsedInContexts(String userId, String termGUID, Integer from, Integer size)	Extract "used-in-contexts" terms
List<GlossaryTerm>	getValidValues(String userId, String termGUID, Integer from, Integer size)	Extract valid values

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Details

GlossaryViewClient

public GlossaryViewClient(String serverName,
 String serverPlatformRootURL)
                   throws InvalidParameterException

Create a new client

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the OMAS REST services

Throws:

InvalidParameterException - null URL or server name

InvalidParameterException

GlossaryViewClient

public GlossaryViewClient(String serverName,
 String serverPlatformRootURL,
 String userId,
 String password)
                   throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - null URL or server name

InvalidParameterException

Method Details

getAllGlossaries

public List<Glossary> getAllGlossaries(String userId,
 Integer from,
 Integer size)
                                throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract all glossary definitions

Parameters:

userId - calling user

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse glossaries

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAllGlossaryTerms

public List<GlossaryTerm> getAllGlossaryTerms(String userId,
 Integer from,
 Integer size)
                                       throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract all glossaryTerms definitions

Parameters:

userId - calling user

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse glossaries

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAllCategories

public List<GlossaryCategory> getAllCategories(String userId,
 Integer from,
 Integer size)
                                        throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract all categories definitions

Parameters:

userId - calling user

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse glossaries

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getGlossary

public Glossary getGlossary(String userId,
 String glossaryGUID)
                     throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract a glossary definition

Parameters:

userId - calling user

glossaryGUID - glossary GUID

Returns:

EntityDetailResponse glossary

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTermHomeGlossary

public Glossary getTermHomeGlossary(String userId,
 String termGUID)
                             throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract a term's home glossary

Parameters:

userId - calling user

termGUID - term GUID

Returns:

EntityDetailResponse glossary

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getCategoryHomeGlossary

public Glossary getCategoryHomeGlossary(String userId,
 String categoryGUID)
                                 throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract a category's home glossary

Parameters:

userId - calling user

categoryGUID - category GUID

Returns:

EntityDetailResponse glossary

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getExternalGlossaryLinksOfGlossary

public List<ExternalGlossaryLink> getExternalGlossaryLinksOfGlossary(String userId,
 String glossaryGUID,
 Integer from,
 Integer size)
                                                              throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract a glossaries's external glossary links

Parameters:

userId - calling user

glossaryGUID - glossary GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse external glossary links

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getCategory

public GlossaryCategory getCategory(String userId,
 String categoryGUID)
                             throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract a category definition

Parameters:

userId - calling user

categoryGUID - category GUID

Returns:

EntityDetailResponse category

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getCategories

public List<GlossaryCategory> getCategories(String userId,
 String glossaryGUID,
 Integer from,
 Integer size)
                                     throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract categories within a glossary

Parameters:

userId - calling user

glossaryGUID - glossary GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse categories

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getSubcategories

public List<GlossaryCategory> getSubcategories(String userId,
 String categoryGUID,
 Integer from,
 Integer size)
                                        throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract subcategories of a category

Parameters:

userId - calling user

categoryGUID - category GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse subcategories

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getExternalGlossaryLinksOfCategory

public List<ExternalGlossaryLink> getExternalGlossaryLinksOfCategory(String userId,
 String categoryGUID,
 Integer from,
 Integer size)
                                                              throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract a category's external glossary links

Parameters:

userId - calling user

categoryGUID - category GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse external glossary links

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTerm

public GlossaryTerm getTerm(String userId,
 String termGUID)
                     throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract a term definition

Parameters:

userId - calling user

termGUID - term GUID

Returns:

EntityDetailResponse term

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTermsOfGlossary

public List<GlossaryTerm> getTermsOfGlossary(String userId,
 String glossaryGUID,
 Integer from,
 Integer size)
                                      throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract terms within a glossary

Parameters:

userId - calling user

glossaryGUID - glossary GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTermsOfCategory

public List<GlossaryTerm> getTermsOfCategory(String userId,
 String categoryGUID,
 Integer from,
 Integer size)
                                      throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract terms within a category

Parameters:

userId - calling user

categoryGUID - category GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getExternalGlossaryLinksOfTerm

public List<ExternalGlossaryLink> getExternalGlossaryLinksOfTerm(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                                          throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract a term's external glossary links

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse external glossary links

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getRelatedTerms

public List<GlossaryTerm> getRelatedTerms(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                   throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract related terms

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getSynonyms

public List<GlossaryTerm> getSynonyms(String userId,
 String termGUID,
 Integer from,
 Integer size)
                               throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract synonyms

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAntonyms

public List<GlossaryTerm> getAntonyms(String userId,
 String termGUID,
 Integer from,
 Integer size)
                               throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract antonyms

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getPreferredTerms

public List<GlossaryTerm> getPreferredTerms(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                     throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract preferred terms

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getReplacementTerms

public List<GlossaryTerm> getReplacementTerms(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                       throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract replacement terms

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTranslations

public List<GlossaryTerm> getTranslations(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                   throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract translations

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getIsA

public List<GlossaryTerm> getIsA(String userId,
 String termGUID,
 Integer from,
 Integer size)
                          throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract "is-a" terms

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getValidValues

public List<GlossaryTerm> getValidValues(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                  throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract valid values

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getUsedInContexts

public List<GlossaryTerm> getUsedInContexts(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                     throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract "used-in-contexts" terms

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAssignedElements

public List<GlossaryTerm> getAssignedElements(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                       throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract assigned elements

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAttributes

public List<GlossaryTerm> getAttributes(String userId,
 String termGUID,
 Integer from,
 Integer size)
                                 throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract attributes

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getSubtypes

public List<GlossaryTerm> getSubtypes(String userId,
 String termGUID,
 Integer from,
 Integer size)
                               throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract subtypes

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTypes

public List<GlossaryTerm> getTypes(String userId,
 String termGUID,
 Integer from,
 Integer size)
                            throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Extract types

Parameters:

userId - calling user

termGUID - term GUID

from - starting index

size - max number of returned entities

Returns:

EntityDetailResponse terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getSingleEntityResponse

protected GlossaryViewEntityDetailResponse getSingleEntityResponse(String methodName,
 String path,
 String serverName,
 String userId,
 String entityGUID)
                                                            throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Throws:

PropertyServerException

InvalidParameterException

GlossaryViewOmasException

getMultipleRelatedEntitiesPagedResponse

protected GlossaryViewEntityDetailResponse getMultipleRelatedEntitiesPagedResponse(String methodName,
 String path,
 String serverName,
 String userId,
 String entityGUID,
 Integer from,
 Integer size)
                                                                            throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Throws:

PropertyServerException

InvalidParameterException

GlossaryViewOmasException

getMultipleEntitiesPagedResponse

protected GlossaryViewEntityDetailResponse getMultipleEntitiesPagedResponse(String methodName,
 String path,
 String serverName,
 String userId,
 Integer from,
 Integer size)
                                                                     throws PropertyServerException,
InvalidParameterException,
GlossaryViewOmasException

Throws:

PropertyServerException

InvalidParameterException

GlossaryViewOmasException