public class OMRSAPIHelper extends Object
| Constructor and Description |
|---|
OMRSAPIHelper(String serviceName,
String serverName,
RepositoryHandler repositoryHandler,
OMRSRepositoryHelper repositoryHelper) |
| Modifier and Type | Method and Description |
|---|---|
List<EntityDetail> |
callFindEntitiesByPropertyValue(String userId,
String entityTypeGUID,
String searchCriteria,
int fromEntityElement,
int pageSize,
Date asOfTime,
String sequencingProperty,
SequencingOrder sequencingOrder,
String restAPIName) |
List<EntityDetail> |
callGetEntitiesByType(String userId,
String entityTypeGUID,
Date asOfTime,
int fromEntityElement,
int pageSize,
String sequencingProperty,
SequencingOrder sequencingOrder,
String restAPIName) |
List<EntityDetail> |
callGetEntitiesForRelationshipEnd(String restAPIName,
String userId,
String anchorEntityGUID,
String anchorEntityTypeName,
boolean anchorAtEnd1,
String relationshipTypeGUID,
String relationshipTypeName,
int startingFrom,
int pageSize) |
List<EntityDetail> |
callGetEntitiesForRelationshipEnd1(String restAPIName,
String userId,
String anchorEntityGUID,
String anchorEntityTypeName,
String relationshipTypeName,
int startingFrom,
int pageSize) |
List<EntityDetail> |
callGetEntitiesForRelationshipEnd2(String restAPIName,
String userId,
String anchorEntityGUID,
String anchorEntityTypeName,
String relationshipTypeName) |
List<EntityDetail> |
callGetEntitiesForRelationshipEnd2(String restAPIName,
String userId,
String anchorEntityGUID,
String anchorEntityTypeName,
String relationshipTypeName,
int startingFrom,
int pageSize) |
InstanceGraph |
callGetEntityNeighbourhood(String restAPIName,
String userId,
String entityGUID,
List<String> entityTypeGUIDs,
List<String> relationshipTypeGUIDs,
List<InstanceStatus> limitResultsByStatus,
List<String> limitResultsByClassification,
Date asOfTime,
int level) |
List<Relationship> |
callGetRelationshipsForEntity(String restAPIName,
String userId,
String entityGUID,
String relationshipTypeGuid,
int fromRelationshipElement,
int pageSize) |
List<Relationship> |
callGetRelationshipsForEntity(String restAPIName,
String userId,
String entityGUID,
String relationshipTypeGuid,
int fromRelationshipElement,
int pageSize,
Date asOfTime,
String sequencingProperty,
SequencingOrder sequencingOrder) |
List<Relationship> |
callGetRelationshipsForEntity(String restAPIName,
String userId,
String entityGUID,
String relationshipTypeGUID,
int fromRelationshipElement,
List<InstanceStatus> limitResultsByStatus,
Date asOfTime,
String sequencingProperty,
SequencingOrder sequencingOrder,
int pageSize) |
String |
callOMRSAddEntity(String restAPIName,
String userId,
EntityDetail entityDetail) |
Optional<Relationship> |
callOMRSAddRelationship(String restAPIName,
String userId,
Relationship relationship) |
void |
callOMRSClassifyEntity(String restAPIName,
String userId,
String entityGUID,
Classification classification) |
void |
callOMRSClassifyEntity(String restAPIName,
String userId,
String entityGUID,
String classificationTypeGUID,
String classificationName,
InstanceProperties instanceProperties) |
void |
callOMRSDeClassifyEntity(String restAPIName,
String userId,
String entityGUID,
String classificationName) |
void |
callOMRSDeleteEntity(String restAPIName,
String userId,
String entityTypeName,
String obsoleteGuid) |
void |
callOMRSDeleteRelationship(String restAPIName,
String userId,
String typeGuid,
String typeName,
String guid) |
Optional<EntityDetail> |
callOMRSGetEntityByGuid(String userId,
String entityGUID,
String entityTypeName,
String restAPIName) |
Optional<Relationship> |
callOMRSGetRelationshipByGuid(String restAPIName,
String userId,
String relationshipGUID) |
void |
callOMRSPurgeEntity(String restAPIName,
String userId,
String entityTypeName,
String obsoleteGuid) |
void |
callOMRSPurgeRelationship(String restAPIName,
String userId,
String typeGuid,
String typeName,
String guid) |
void |
callOMRSRestoreEntity(String restAPIName,
String userId,
String deletedEntityGUID) |
void |
callOMRSRestoreRelationship(String restAPIName,
String userId,
String guid) |
void |
callOMRSUpdateClassification(String restAPIName,
String userId,
String entityGUID,
Classification existingClassification,
InstanceProperties newProperties) |
Optional<EntityDetail> |
callOMRSUpdateEntity(String restAPIName,
String userId,
EntityDetail entityDetail) |
void |
callOMRSUpdateRelationship(String restAPIName,
String userId,
Relationship relationship) |
List<EntityDetail> |
findEntitiesByPropertyValue(String restAPIName,
String userId,
String typeName,
FindRequest findRequest) |
List<EntityDetail> |
findEntitiesByPropertyValue(String restAPIName,
String userId,
String typeName,
String searchCriteria,
Date asOfTime,
int startingFrom,
int pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty) |
List<Relationship> |
getAllRelationshipsForEntity(String restAPIName,
String userId,
String entityGUID,
FindRequest findRequest) |
List<EntityDetail> |
getEntitiesByType(String restAPIName,
String userId,
String typeName,
Date asOfTime,
int startingFrom,
int pageSize,
String sequencingProperty,
SequencingOrder sequencingOrder) |
List<EntityDetail> |
getEntitiesByType(String restAPIName,
String userId,
String typeName,
FindRequest findRequest) |
OMRSRepositoryHelper |
getOMRSRepositoryHelper() |
List<Relationship> |
getRelationshipsByType(String userId,
String entityGuid,
String entityTypeName,
String relationshipTypeName,
String methodName) |
RepositoryHandler |
getRepositoryHandler() |
String |
getServiceName()
Get the service name - ths is used for logging
|
String |
getTypeDefGUID(String typeDefName) |
String |
getTypeDefGUID(String sourceName,
String typeDefName) |
boolean |
isEmptyContent(List<String> relationshipTypeNames,
String userId,
String entityGuid,
String entityTypeName,
String methodName) |
boolean |
isTypeOf(String actualTypeName,
String expectedTypeName) |
public OMRSAPIHelper(String serviceName, String serverName, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper)
serviceName - name of the consuming serviceserverName - name of this server instancerepositoryHelper - helper used by the convertersrepositoryHandler - issues common calls to the open metadata repository to retrieve and store metadatapublic String getServiceName()
public OMRSRepositoryHelper getOMRSRepositoryHelper()
public RepositoryHandler getRepositoryHandler()
public String callOMRSAddEntity(String restAPIName, String userId, EntityDetail entityDetail) throws SubjectAreaCheckedException, UserNotAuthorizedException, PropertyServerException
public Optional<EntityDetail> callOMRSGetEntityByGuid(String userId, String entityGUID, String entityTypeName, String restAPIName) throws SubjectAreaCheckedException, PropertyServerException, UserNotAuthorizedException, InvalidParameterException
public List<EntityDetail> callFindEntitiesByPropertyValue(String userId, String entityTypeGUID, String searchCriteria, int fromEntityElement, int pageSize, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, String restAPIName) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public List<EntityDetail> callGetEntitiesByType(String userId, String entityTypeGUID, Date asOfTime, int fromEntityElement, int pageSize, String sequencingProperty, SequencingOrder sequencingOrder, String restAPIName) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public Optional<EntityDetail> callOMRSUpdateEntity(String restAPIName, String userId, EntityDetail entityDetail) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSDeleteEntity(String restAPIName, String userId, String entityTypeName, String obsoleteGuid) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSPurgeEntity(String restAPIName, String userId, String entityTypeName, String obsoleteGuid) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSRestoreEntity(String restAPIName, String userId, String deletedEntityGUID) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSClassifyEntity(String restAPIName, String userId, String entityGUID, Classification classification) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSClassifyEntity(String restAPIName, String userId, String entityGUID, String classificationTypeGUID, String classificationName, InstanceProperties instanceProperties) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSUpdateClassification(String restAPIName, String userId, String entityGUID, Classification existingClassification, InstanceProperties newProperties) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSDeClassifyEntity(String restAPIName, String userId, String entityGUID, String classificationName) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public Optional<Relationship> callOMRSAddRelationship(String restAPIName, String userId, Relationship relationship) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public Optional<Relationship> callOMRSGetRelationshipByGuid(String restAPIName, String userId, String relationshipGUID) throws SubjectAreaCheckedException, UserNotAuthorizedException, PropertyServerException
public void callOMRSUpdateRelationship(String restAPIName, String userId, Relationship relationship) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSDeleteRelationship(String restAPIName, String userId, String typeGuid, String typeName, String guid) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSRestoreRelationship(String restAPIName, String userId, String guid) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public void callOMRSPurgeRelationship(String restAPIName, String userId, String typeGuid, String typeName, String guid) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public List<Relationship> getRelationshipsByType(String userId, String entityGuid, String entityTypeName, String relationshipTypeName, String methodName) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public List<Relationship> callGetRelationshipsForEntity(String restAPIName, String userId, String entityGUID, String relationshipTypeGuid, int fromRelationshipElement, int pageSize) throws PropertyServerException, SubjectAreaCheckedException, UserNotAuthorizedException
public List<Relationship> getAllRelationshipsForEntity(String restAPIName, String userId, String entityGUID, FindRequest findRequest) throws PropertyServerException, SubjectAreaCheckedException, UserNotAuthorizedException
public List<Relationship> callGetRelationshipsForEntity(String restAPIName, String userId, String entityGUID, String relationshipTypeGuid, int fromRelationshipElement, int pageSize, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder) throws SubjectAreaCheckedException, PropertyServerException, UserNotAuthorizedException
public List<Relationship> callGetRelationshipsForEntity(String restAPIName, String userId, String entityGUID, String relationshipTypeGUID, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws UserNotAuthorizedException, PropertyServerException, SubjectAreaCheckedException
public List<EntityDetail> callGetEntitiesForRelationshipEnd2(String restAPIName, String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeName) throws PropertyServerException, SubjectAreaCheckedException, UserNotAuthorizedException
public List<EntityDetail> callGetEntitiesForRelationshipEnd1(String restAPIName, String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeName, int startingFrom, int pageSize) throws PropertyServerException, SubjectAreaCheckedException, UserNotAuthorizedException
public List<EntityDetail> callGetEntitiesForRelationshipEnd2(String restAPIName, String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeName, int startingFrom, int pageSize) throws PropertyServerException, SubjectAreaCheckedException, UserNotAuthorizedException
public List<EntityDetail> callGetEntitiesForRelationshipEnd(String restAPIName, String userId, String anchorEntityGUID, String anchorEntityTypeName, boolean anchorAtEnd1, String relationshipTypeGUID, String relationshipTypeName, int startingFrom, int pageSize) throws SubjectAreaCheckedException, UserNotAuthorizedException, PropertyServerException
public InstanceGraph callGetEntityNeighbourhood(String restAPIName, String userId, String entityGUID, List<String> entityTypeGUIDs, List<String> relationshipTypeGUIDs, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, int level) throws SubjectAreaCheckedException, UserNotAuthorizedException, PropertyServerException
public List<EntityDetail> findEntitiesByPropertyValue(String restAPIName, String userId, String typeName, FindRequest findRequest) throws PropertyServerException, SubjectAreaCheckedException, UserNotAuthorizedException
public List<EntityDetail> findEntitiesByPropertyValue(String restAPIName, String userId, String typeName, String searchCriteria, Date asOfTime, int startingFrom, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) throws SubjectAreaCheckedException, PropertyServerException, UserNotAuthorizedException
public List<EntityDetail> getEntitiesByType(String restAPIName, String userId, String typeName, FindRequest findRequest) throws PropertyServerException, SubjectAreaCheckedException, UserNotAuthorizedException
public List<EntityDetail> getEntitiesByType(String restAPIName, String userId, String typeName, Date asOfTime, int startingFrom, int pageSize, String sequencingProperty, SequencingOrder sequencingOrder) throws SubjectAreaCheckedException, PropertyServerException, UserNotAuthorizedException
public boolean isEmptyContent(List<String> relationshipTypeNames, String userId, String entityGuid, String entityTypeName, String methodName) throws SubjectAreaCheckedException, PropertyServerException, UserNotAuthorizedException
relationshipTypeNames - relationships type names for searchuserId - unique identifier for requesting user, under which the request is performedentityGuid - guid of the glossary to be deleted.entityTypeName - starting entity's type namemethodName - name of the method being called.PropertyServerException - something went wrong with the REST call stack.UserNotAuthorizedException - the requesting user is not authorized to issue this request.SubjectAreaCheckedException - standard exception Subject Area OMAS servicesCopyright © 2018–2021 LF AI & Data Foundation. All rights reserved.