Package org.odpi.openmetadata.accessservices.glossaryview.server.service

Class OMRSClient

java.lang.Object

org.odpi.openmetadata.accessservices.glossaryview.server.service.OMRSClient

Direct Known Subclasses:

GlossaryViewOMAS

public class OMRSClient
extends Object

Queries OMRS layer. Incoming known exceptions are thrown as they are or a GlossaryViewOmasException is built and thrown.

Field Summary

Fields

Modifier and Type	Field	Description
protected GlossaryViewInstanceHandler	instanceHandler

Constructor Summary

Constructors

Constructor	Description
OMRSClient()

Method Summary

Modifier and Type	Method	Description
protected List<EntityDetail>	getAllEntityDetails(String userId, String serverName, String entityTypeGUID, Integer from, Integer size, String methodName)	Extract all entity definitions
protected Optional<EntityDetail>	getEntityDetail(String userId, String serverName, String guid, String entityTypeName, String methodName)	Extract an entity detail for the given GUID
protected 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 guid
protected List<EntityDetail>	getSubEntities(String userId, String serverName, String entityGUID, String entityTypeName, boolean anchorAtEnd1, String relationshipTypeGUID, String relationshipTypeName, Integer from, Integer size, String methodName)	Extract entities related to provided guid

Methods inherited from class java.lang.Object

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

Field Detail

instanceHandler

protected GlossaryViewInstanceHandler instanceHandler

Constructor Detail

OMRSClient

public OMRSClient()

Method Detail

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 user

serverName - instance to call

guid - entity to extract

entityTypeName - entity type name

methodName - 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 PropertyServerException

InvalidParameterException

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 user

serverName - instance to call

entityGUID - target entity

entityTypeName - entity type name

relationshipTypeGUID - relationship type guid to navigate

relationshipTypeName - relationship type name to navigate

from - from

size - size

methodName - calling method

Returns:

entities if found

Throws:

GlossaryViewOmasException - if any exception is thrown from repository level, other than InvalidParameterException, UserNotAuthorizedException or PropertyServerException

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

getSubEntities

protected List<EntityDetail> getSubEntities(String userId,
                                            String serverName,
                                            String entityGUID,
                                            String entityTypeName,
                                            boolean anchorAtEnd1,
                                            String relationshipTypeGUID,
                                            String relationshipTypeName,
                                            Integer from,
                                            Integer size,
                                            String methodName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException,
                                            GlossaryViewOmasException

Extract entities related to provided guid

Parameters:

userId - calling user

serverName - instance to call

entityGUID - target entity

entityTypeName - entity type name

anchorAtEnd1 - which end should the target entity be at

relationshipTypeGUID - relationship type guid to navigate

relationshipTypeName - relationship type name to navigate

from - from

size - size

methodName - calling method

Returns:

entities if found

Throws:

GlossaryViewOmasException - if any exception is thrown from repository level, other than InvalidParameterException, UserNotAuthorizedException or PropertyServerException

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

getAllEntityDetails

protected List<EntityDetail> getAllEntityDetails(String userId,
                                                 String serverName,
                                                 String entityTypeGUID,
                                                 Integer from,
                                                 Integer size,
                                                 String methodName)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException,
                                                 GlossaryViewOmasException

Extract all entity definitions

Parameters:

userId - calling user

serverName - instance to call

entityTypeGUID - entity type

from - from

size - size

methodName - calling method

Returns:

entities if found

Throws:

GlossaryViewOmasException - if any exception is thrown from repository level, other than InvalidParameterException, UserNotAuthorizedException or PropertyServerException

InvalidParameterException

UserNotAuthorizedException

PropertyServerException