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
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
ConstructorsConstructorDescriptionGlossaryViewClient
(String serverName, String serverPlatformRootURL) Create a new clientGlossaryViewClient
(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 TypeMethodDescriptiongetAllCategories
(String userId, Integer from, Integer size) Extract all categories definitionsgetAllGlossaries
(String userId, Integer from, Integer size) Extract all glossary definitionsgetAllGlossaryTerms
(String userId, Integer from, Integer size) Extract all glossaryTerms definitionsgetAntonyms
(String userId, String termGUID, Integer from, Integer size) Extract antonymsgetAssignedElements
(String userId, String termGUID, Integer from, Integer size) Extract assigned elementsgetAttributes
(String userId, String termGUID, Integer from, Integer size) Extract attributesgetCategories
(String userId, String glossaryGUID, Integer from, Integer size) Extract categories within a glossarygetCategory
(String userId, String categoryGUID) Extract a category definitiongetCategoryHomeGlossary
(String userId, String categoryGUID) Extract a category's home glossarygetExternalGlossaryLinksOfCategory
(String userId, String categoryGUID, Integer from, Integer size) Extract a category's external glossary linksgetExternalGlossaryLinksOfGlossary
(String userId, String glossaryGUID, Integer from, Integer size) Extract a glossaries's external glossary linksgetExternalGlossaryLinksOfTerm
(String userId, String termGUID, Integer from, Integer size) Extract a term's external glossary linksgetGlossary
(String userId, String glossaryGUID) Extract a glossary definitionExtract "is-a" termsprotected 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) getPreferredTerms
(String userId, String termGUID, Integer from, Integer size) Extract preferred termsgetRelatedTerms
(String userId, String termGUID, Integer from, Integer size) Extract related termsgetReplacementTerms
(String userId, String termGUID, Integer from, Integer size) Extract replacement termsprotected GlossaryViewEntityDetailResponse
getSingleEntityResponse
(String methodName, String path, String serverName, String userId, String entityGUID) getSubcategories
(String userId, String categoryGUID, Integer from, Integer size) Extract subcategories of a categorygetSubtypes
(String userId, String termGUID, Integer from, Integer size) Extract subtypesgetSynonyms
(String userId, String termGUID, Integer from, Integer size) Extract synonymsExtract a term definitiongetTermHomeGlossary
(String userId, String termGUID) Extract a term's home glossarygetTermsOfCategory
(String userId, String categoryGUID, Integer from, Integer size) Extract terms within a categorygetTermsOfGlossary
(String userId, String glossaryGUID, Integer from, Integer size) Extract terms within a glossarygetTranslations
(String userId, String termGUID, Integer from, Integer size) Extract translationsExtract typesgetUsedInContexts
(String userId, String termGUID, Integer from, Integer size) Extract "used-in-contexts" termsgetValidValues
(String userId, String termGUID, Integer from, Integer size) Extract valid valuesMethods 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
-
Constructor Details
-
GlossaryViewClient
public GlossaryViewClient(String serverName, String serverPlatformRootURL) throws InvalidParameterException Create a new client- Parameters:
serverName
- name of the server to connect toserverPlatformRootURL
- the network address of the server running the OMAS REST services- Throws:
InvalidParameterException
- null URL or server nameInvalidParameterException
-
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 toserverPlatformRootURL
- the network address of the server running the OMAS REST servicesuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requests- Throws:
InvalidParameterException
- null URL or server nameInvalidParameterException
-
-
Method Details
-
getAllGlossaries
public List<Glossary> getAllGlossaries(String userId, Integer from, Integer size) throws PropertyServerException, InvalidParameterException, GlossaryViewOmasException Extract all glossary definitions- Parameters:
userId
- calling userfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse glossaries
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 userfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse glossaries
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 userfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse glossaries
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 userglossaryGUID
- glossary GUID- Returns:
- EntityDetailResponse glossary
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUID- Returns:
- EntityDetailResponse glossary
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usercategoryGUID
- category GUID- Returns:
- EntityDetailResponse glossary
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 userglossaryGUID
- glossary GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse external glossary links
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usercategoryGUID
- category GUID- Returns:
- EntityDetailResponse category
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 userglossaryGUID
- glossary GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse categories
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usercategoryGUID
- category GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse subcategories
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usercategoryGUID
- category GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse external glossary links
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUID- Returns:
- EntityDetailResponse term
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 userglossaryGUID
- glossary GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usercategoryGUID
- category GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse external glossary links
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 usertermGUID
- term GUIDfrom
- starting indexsize
- max number of returned entities- Returns:
- EntityDetailResponse terms
- Throws:
PropertyServerException
- if a problem occurs while serving the requestInvalidParameterException
- if parameter validation failsGlossaryViewOmasException
- 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 -
getMultipleRelatedEntitiesPagedResponse
protected GlossaryViewEntityDetailResponse getMultipleRelatedEntitiesPagedResponse(String methodName, String path, String serverName, String userId, String entityGUID, Integer from, Integer size) throws PropertyServerException, InvalidParameterException, GlossaryViewOmasException -
getMultipleEntitiesPagedResponse
protected GlossaryViewEntityDetailResponse getMultipleEntitiesPagedResponse(String methodName, String path, String serverName, String userId, Integer from, Integer size) throws PropertyServerException, InvalidParameterException, GlossaryViewOmasException
-