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, String serverName, OMRSRepositoryHelper repositoryHelper, OMRSMetadataCollection omrsMetadataCollection)

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, String sequencingProperty, SequencingOrder sequencingOrder)
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	convertOMRSRelationshipsToOMASLines(List<Relationship> omrsRelationships) Convert the OMRS Lines to their equivalent OMAS objects and return them in a Response of type lines.
SubjectAreaOMASAPIResponse	findEntitiesByPropertyValue(String restAPIName, String userId, String typeName, String searchCriteria, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty)
SubjectAreaOMASAPIResponse	getEntitiesByType(String restAPIName, String userId, String typeName, Date asOfTime, int offset, int pageSize, String sequencingProperty, SequencingOrder sequencingOrder)
SubjectAreaOMASAPIResponse	getGlossarySummary(String restAPIName, String userId, Line line) Get glossary summary
SubjectAreaOMASAPIResponse	getIconSummarySet(String userId, String guid) Set icon summaries from related media relationships by issuing a call to omrs using the related media guid - which is at one end of the relationship.
OMRSMetadataCollection	getOMRSMetadataCollection(String restAPIName)
OMRSRepositoryHelper	getOMRSRepositoryHelper()
CategorySummary	getParentCategorySummary(String restAPIName, String userId, Set<Line> lines) Get a summary of the parent category.
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,
                     String serverName,
                     OMRSRepositoryHelper repositoryHelper,
                     OMRSMetadataCollection omrsMetadataCollection)

Parameters:

serviceName - name of the consuming service

serverName - name of this server instance

repositoryHelper - helper used by the converters

omrsMetadataCollection - metadata collection for the repository

Method Detail

getServiceName

public String getServiceName()

Get the service name - ths is used for logging

Returns:

service name

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

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,
                                                        String sequencingProperty,
                                                        SequencingOrder sequencingOrder)

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,
                                                              int offset,
                                                              int pageSize,
                                                              SequencingOrder sequencingOrder,
                                                              String sequencingProperty)

getEntitiesByType

public SubjectAreaOMASAPIResponse getEntitiesByType(String restAPIName,
                                                    String userId,
                                                    String typeName,
                                                    Date asOfTime,
                                                    int offset,
                                                    int pageSize,
                                                    String sequencingProperty,
                                                    SequencingOrder sequencingOrder)

getIconSummarySet

public SubjectAreaOMASAPIResponse getIconSummarySet(String userId,
                                                    String guid)

Set icon summaries from related media relationships by issuing a call to omrs using the related media guid - which is at one end of the relationship. Note that we should only return the icons that are effective - by checking the effective From and To dates against the current time

Parameters:

userId - userid under which to issue to the get of the related media

guid - to get associated icons from

Returns:

response with Set of IconSummary objects or an Exception response.

getGlossarySummary

public SubjectAreaOMASAPIResponse getGlossarySummary(String restAPIName,
                                                     String userId,
                                                     Line line)

Get glossary summary

Parameters:

restAPIName - rest API Name

userId - userid under which to issue to the get of the related media

line - glossary relationship TermAnchor or CategoryAnchor

Returns:

Glossary summary

getParentCategorySummary

public CategorySummary getParentCategorySummary(String restAPIName,
                                                String userId,
                                                Set<Line> lines)
                                         throws InvalidParameterException

Get a summary of the parent category. The parent category is optional. We might validly have more than one parent category. this can occur if effectivity dates are being used The parent category is the first relationship we find of the right type that is effective.

Parameters:

restAPIName - rest API Name

userId - userid that the requests are issued under

lines - set of Lines that are of the right type.

Returns:

a parent category as a CategorySummary

Throws:

InvalidParameterException - one of the parameters is null or invalid.

convertOMRSRelationshipsToOMASLines

public SubjectAreaOMASAPIResponse convertOMRSRelationshipsToOMASLines(List<Relationship> omrsRelationships)

Convert the OMRS Lines to their equivalent OMAS objects and return them in a Response of type lines.

Parameters:

omrsRelationships - - these are OMRS relationships

Returns:

omasLines - these are the Lines (the OMAS relationships) that are exposed in the OMAS API - note the list in the response can be empty