org.odpi.openmetadata.accessservices.subjectarea.utilities

Class OMRSAPIHelper

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.utilities.OMRSAPIHelper

public class OMRSAPIHelper
extends Object

This is a facade around the OMRS API. It transforms the OMRS Exceptions into OMAS exceptions

Constructor Summary

Constructors

Constructor and Description
OMRSAPIHelper(String serviceName)

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	callFindEntitiesByPropertyValue(String restAPIName, String userId, String entityTypeGUID, String searchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
SubjectAreaOMASAPIResponse	callGetEntitiesByType(String restAPIName, String userId, String entityTypeGUID, Date asOfTime, int fromEntityElement, int pageSize)
SubjectAreaOMASAPIResponse	callGetEntityNeighbourhood(String restAPIName, String userId, String entityGUID, List<String> entityTypeGUIDs, List<String> relationshipTypeGUIDs, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, int level)
SubjectAreaOMASAPIResponse	callGetRelationshipsForEntity(String restAPIName, String userId, String entityGUID, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
SubjectAreaOMASAPIResponse	callGetRelationshipsForEntity(String restAPIName, String userId, String entityGUID, String relationshipTypeGUID, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
SubjectAreaOMASAPIResponse	callOMRSAddEntity(String restAPIName, String userId, EntityDetail entityDetail)
SubjectAreaOMASAPIResponse	callOMRSAddRelationship(String restAPIName, String userId, Relationship relationship)
SubjectAreaOMASAPIResponse	callOMRSClassifyEntity(String restAPIName, String userId, String entityGUID, String classificationName, InstanceProperties instanceProperties)
SubjectAreaOMASAPIResponse	callOMRSDeClassifyEntity(String restAPIName, String userId, String entityGUID, String classificationName)
SubjectAreaOMASAPIResponse	callOMRSDeleteEntity(String restAPIName, String userId, String typeDefName, String typeDefGuid, String obsoleteGuid)
SubjectAreaOMASAPIResponse	callOMRSDeleteRelationship(String restAPIName, String userId, String typeGuid, String typeName, String guid)
SubjectAreaOMASAPIResponse	callOMRSGetEntityByGuid(String restAPIName, String userId, String entityGUID)
SubjectAreaOMASAPIResponse	callOMRSGetRelationshipByGuid(String restAPIName, String userId, String relationshipGUID)
SubjectAreaOMASAPIResponse	callOMRSPurgeEntity(String restAPIName, String userId, String typeDefName, String typeDefGuid, String obsoleteGuid)
SubjectAreaOMASAPIResponse	callOMRSPurgeRelationship(String restAPIName, String userId, String typeGuid, String typeName, String guid)
SubjectAreaOMASAPIResponse	callOMRSRestoreEntity(String restAPIName, String userId, String guid)
SubjectAreaOMASAPIResponse	callOMRSRestoreRelationship(String restAPIName, String userId, String guid)
SubjectAreaOMASAPIResponse	callOMRSUpdateEntityProperties(String restAPIName, String userId, EntityDetail entityDetail)
SubjectAreaOMASAPIResponse	callOMRSUpdateRelationship(String restAPIName, String userId, Relationship relationship)
SubjectAreaOMASAPIResponse	findEntitiesByPropertyValue(String restAPIName, String userId, String typeName, String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty, String methodName)
SubjectAreaOMASAPIResponse	getEntitiesByType(OMRSAPIHelper oMRSAPIHelper, String restAPIName, String userId, String typeName, Date asOfTime, Integer offset, Integer pageSize)
OMRSMetadataCollection	getOMRSMetadataCollection(String restAPIName)
OMRSRepositoryHelper	getOMRSRepositoryHelper()
String	getServiceName() Get the service name - ths is used for logging
void	setOMRSRepositoryConnector(OMRSRepositoryConnector connector, String restAPIName) Set the OMRS repository connector

Methods inherited from class java.lang.Object

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

Constructor Detail

OMRSAPIHelper

public OMRSAPIHelper(String serviceName)

Method Detail

getOMRSMetadataCollection

public OMRSMetadataCollection getOMRSMetadataCollection(String restAPIName)
                                                 throws MetadataServerUncontactableException

Throws:

MetadataServerUncontactableException

getOMRSRepositoryHelper

public OMRSRepositoryHelper getOMRSRepositoryHelper()

setOMRSRepositoryConnector

public void setOMRSRepositoryConnector(OMRSRepositoryConnector connector,
                                       String restAPIName)
                                throws MetadataServerUncontactableException

Set the OMRS repository connector

Parameters:

connector - connector cannot be null

restAPIName - rest API name

Throws:

MetadataServerUncontactableException - Metadata server not contactable

getServiceName

public String getServiceName()

Get the service name - ths is used for logging

Returns:

service name

callOMRSAddEntity

public SubjectAreaOMASAPIResponse callOMRSAddEntity(String restAPIName,
                                                    String userId,
                                                    EntityDetail entityDetail)

callOMRSGetEntityByGuid

public SubjectAreaOMASAPIResponse callOMRSGetEntityByGuid(String restAPIName,
                                                          String userId,
                                                          String entityGUID)

callFindEntitiesByPropertyValue

public SubjectAreaOMASAPIResponse callFindEntitiesByPropertyValue(String restAPIName,
                                                                  String userId,
                                                                  String entityTypeGUID,
                                                                  String searchCriteria,
                                                                  int fromEntityElement,
                                                                  List<InstanceStatus> limitResultsByStatus,
                                                                  List<String> limitResultsByClassification,
                                                                  Date asOfTime,
                                                                  String sequencingProperty,
                                                                  SequencingOrder sequencingOrder,
                                                                  int pageSize)

callGetEntitiesByType

public SubjectAreaOMASAPIResponse callGetEntitiesByType(String restAPIName,
                                                        String userId,
                                                        String entityTypeGUID,
                                                        Date asOfTime,
                                                        int fromEntityElement,
                                                        int pageSize)

callOMRSUpdateEntityProperties

public SubjectAreaOMASAPIResponse callOMRSUpdateEntityProperties(String restAPIName,
                                                                 String userId,
                                                                 EntityDetail entityDetail)

callOMRSDeleteEntity

public SubjectAreaOMASAPIResponse callOMRSDeleteEntity(String restAPIName,
                                                       String userId,
                                                       String typeDefName,
                                                       String typeDefGuid,
                                                       String obsoleteGuid)

callOMRSPurgeEntity

public SubjectAreaOMASAPIResponse callOMRSPurgeEntity(String restAPIName,
                                                      String userId,
                                                      String typeDefName,
                                                      String typeDefGuid,
                                                      String obsoleteGuid)

callOMRSRestoreEntity

public SubjectAreaOMASAPIResponse callOMRSRestoreEntity(String restAPIName,
                                                        String userId,
                                                        String guid)

callOMRSClassifyEntity

public SubjectAreaOMASAPIResponse callOMRSClassifyEntity(String restAPIName,
                                                         String userId,
                                                         String entityGUID,
                                                         String classificationName,
                                                         InstanceProperties instanceProperties)

callOMRSDeClassifyEntity

public SubjectAreaOMASAPIResponse callOMRSDeClassifyEntity(String restAPIName,
                                                           String userId,
                                                           String entityGUID,
                                                           String classificationName)

callOMRSAddRelationship

public SubjectAreaOMASAPIResponse callOMRSAddRelationship(String restAPIName,
                                                          String userId,
                                                          Relationship relationship)

callOMRSGetRelationshipByGuid

public SubjectAreaOMASAPIResponse callOMRSGetRelationshipByGuid(String restAPIName,
                                                                String userId,
                                                                String relationshipGUID)

callOMRSUpdateRelationship

public SubjectAreaOMASAPIResponse callOMRSUpdateRelationship(String restAPIName,
                                                             String userId,
                                                             Relationship relationship)

callOMRSDeleteRelationship

public SubjectAreaOMASAPIResponse callOMRSDeleteRelationship(String restAPIName,
                                                             String userId,
                                                             String typeGuid,
                                                             String typeName,
                                                             String guid)

callOMRSRestoreRelationship

public SubjectAreaOMASAPIResponse callOMRSRestoreRelationship(String restAPIName,
                                                              String userId,
                                                              String guid)

callOMRSPurgeRelationship

public SubjectAreaOMASAPIResponse callOMRSPurgeRelationship(String restAPIName,
                                                            String userId,
                                                            String typeGuid,
                                                            String typeName,
                                                            String guid)

callGetRelationshipsForEntity

public SubjectAreaOMASAPIResponse callGetRelationshipsForEntity(String restAPIName,
                                                                String userId,
                                                                String entityGUID,
                                                                String relationshipTypeGuid,
                                                                int fromRelationshipElement,
                                                                Date asOfTime,
                                                                String sequencingProperty,
                                                                SequencingOrder sequencingOrder,
                                                                int pageSize)

callGetRelationshipsForEntity

public SubjectAreaOMASAPIResponse callGetRelationshipsForEntity(String restAPIName,
                                                                String userId,
                                                                String entityGUID,
                                                                String relationshipTypeGUID,
                                                                int fromRelationshipElement,
                                                                List<InstanceStatus> limitResultsByStatus,
                                                                Date asOfTime,
                                                                String sequencingProperty,
                                                                SequencingOrder sequencingOrder,
                                                                int pageSize)

callGetEntityNeighbourhood

public SubjectAreaOMASAPIResponse callGetEntityNeighbourhood(String restAPIName,
                                                             String userId,
                                                             String entityGUID,
                                                             List<String> entityTypeGUIDs,
                                                             List<String> relationshipTypeGUIDs,
                                                             List<InstanceStatus> limitResultsByStatus,
                                                             List<String> limitResultsByClassification,
                                                             Date asOfTime,
                                                             int level)

findEntitiesByPropertyValue

public SubjectAreaOMASAPIResponse findEntitiesByPropertyValue(String restAPIName,
                                                              String userId,
                                                              String typeName,
                                                              String searchCriteria,
                                                              Date asOfTime,
                                                              Integer offset,
                                                              Integer pageSize,
                                                              SequencingOrder sequencingOrder,
                                                              String sequencingProperty,
                                                              String methodName)

getEntitiesByType

public SubjectAreaOMASAPIResponse getEntitiesByType(OMRSAPIHelper oMRSAPIHelper,
                                                    String restAPIName,
                                                    String userId,
                                                    String typeName,
                                                    Date asOfTime,
                                                    Integer offset,
                                                    Integer pageSize)