Class OMRSClient
java.lang.Object
org.odpi.openmetadata.accessservices.glossaryview.server.service.OMRSClient
- Direct Known Subclasses:
GlossaryViewOMAS
Queries OMRS layer. Incoming known exceptions are thrown as they are or a
GlossaryViewOmasException
is built and thrown.-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected List<EntityDetail>
getAllEntityDetails
(String userId, String serverName, String entityTypeName, String entityTypeGUID, Integer from, Integer size, String methodName) Extract all entity definitionsprotected Optional<EntityDetail>
getEntityDetail
(String userId, String serverName, String guid, String entityTypeName, String methodName) Extract an entity detail for the given GUIDprotected List<EntityDetail>
getRelatedEntities
(String userId, String serverName, String entityGUID, String entityTypeName, String relationshipTypeGUID, String relationshipTypeName, Integer from, Integer size, String methodName) Extract entities related to provided guidprotected List<EntityDetail>
getSubEntities
(String userId, String serverName, String entityGUID, String entityTypeName, String relationshipTypeGUID, String relationshipTypeName, Integer from, Integer size, String methodName) Extract entities related to provided guid
-
Field Details
-
instanceHandler
-
-
Constructor Details
-
OMRSClient
public OMRSClient()
-
-
Method Details
-
getEntityDetail
protected Optional<EntityDetail> getEntityDetail(String userId, String serverName, String guid, String entityTypeName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, GlossaryViewOmasException Extract an entity detail for the given GUID- Parameters:
userId
- calling userserverName
- instance to callguid
- entity to extractentityTypeName
- entity type namemethodName
- calling method- Returns:
- optional with entity details if found, empty optional if not
- Throws:
GlossaryViewOmasException
- if any exception is thrown from repository level, other than InvalidParameterException, UserNotAuthorizedException or PropertyServerExceptionInvalidParameterException
UserNotAuthorizedException
PropertyServerException
-
getRelatedEntities
protected List<EntityDetail> getRelatedEntities(String userId, String serverName, String entityGUID, String entityTypeName, String relationshipTypeGUID, String relationshipTypeName, Integer from, Integer size, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, GlossaryViewOmasException Extract entities related to provided guid- Parameters:
userId
- calling userserverName
- instance to callentityGUID
- target entityentityTypeName
- entity type namerelationshipTypeGUID
- relationship type guid to navigaterelationshipTypeName
- relationship type name to navigatefrom
- fromsize
- sizemethodName
- calling method- Returns:
- entities if found
- Throws:
GlossaryViewOmasException
- if any exception is thrown from repository level, other than InvalidParameterException, UserNotAuthorizedException or PropertyServerExceptionInvalidParameterException
UserNotAuthorizedException
PropertyServerException
-
getSubEntities
protected List<EntityDetail> getSubEntities(String userId, String serverName, String entityGUID, String entityTypeName, String relationshipTypeGUID, String relationshipTypeName, Integer from, Integer size, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, GlossaryViewOmasException Extract entities related to provided guid- Parameters:
userId
- calling userserverName
- instance to callentityGUID
- target entityentityTypeName
- entity type namerelationshipTypeGUID
- relationship type guid to navigaterelationshipTypeName
- relationship type name to navigatefrom
- fromsize
- sizemethodName
- calling method- Returns:
- entities if found
- Throws:
GlossaryViewOmasException
- if any exception is thrown from repository level, other than InvalidParameterException, UserNotAuthorizedException or PropertyServerExceptionInvalidParameterException
UserNotAuthorizedException
PropertyServerException
-
getAllEntityDetails
protected List<EntityDetail> getAllEntityDetails(String userId, String serverName, String entityTypeName, String entityTypeGUID, Integer from, Integer size, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, GlossaryViewOmasException Extract all entity definitions- Parameters:
userId
- calling userserverName
- instance to callentityTypeName
- entity type nameentityTypeGUID
- entity type guidfrom
- fromsize
- sizemethodName
- calling method- Returns:
- entities if found
- Throws:
GlossaryViewOmasException
- if any exception is thrown from repository level, other than InvalidParameterException, UserNotAuthorizedException or PropertyServerExceptionInvalidParameterException
UserNotAuthorizedException
PropertyServerException
-