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()

Method Summary

Modifier and Type	Method and Description
List<EntityDetail>	callFindEntitiesByPropertyValue(String userId, String entityTypeGUID, String searchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
TypeDefGallery	callGetAllTypes(String userId)
InstanceGraph	callGetEntityNeighbourhood(String userId, String entityGUID, List<String> entityTypeGUIDs, List<String> relationshipTypeGUIDs, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, int level)
List<Relationship>	callGetRelationshipsForEntity(String userId, String entityGUID, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
List<Relationship>	callGetRelationshipsForEntity(String userId, String entityGUID, String relationshipTypeGUID, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
TypeDef	callGetTypeDefByName(String userId, String typeName)
String	callGetTypeGuid(String userId, String typeName)
EntityDetail	callOMRSAddEntity(String userId, EntityDetail entityDetail)
Relationship	callOMRSAddRelationship(String userId, Relationship relationship)
EntityDetail	callOMRSClassifyEntity(String userId, String entityGUID, String classificationName, InstanceProperties instanceProperties)
EntityDetail	callOMRSDeClassifyEntity(String userId, String entityGUID, String classificationName)
EntityDetail	callOMRSDeleteEntity(String userId, String typeDefName, String typeDefGuid, String obsoleteGuid)
Relationship	callOMRSDeleteRelationship(String userId, String typeGuid, String typeName, String guid)
EntityDetail	callOMRSGetEntityByGuid(String userId, String entityGUID)
Relationship	callOMRSGetRelationshipByGuid(String userId, String relationshipGUID)
void	callOMRSPurgeEntity(String userId, String typeDefName, String typeDefGuid, String obsoleteGuid)
void	callOMRSPurgeRelationship(String userId, String typeGuid, String typeName, String guid)
EntityDetail	callOMRSRestoreEntity(String userId, String guid)
Relationship	callOMRSRestoreRelationship(String userId, String guid)
EntityDetail	callOMRSUpdateEntity(String userId, EntityDetail entityDetail)
Relationship	callOMRSUpdateRelationship(String userId, Relationship relationship)
static List<EntityDetail>	findEntitiesByType(OMRSAPIHelper oMRSAPIHelper, String serverName, String userId, String type, String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty, String methodName)
OMRSMetadataCollection	getOMRSMetadataCollection()
OMRSRepositoryHelper	getOMRSRepositoryHelper()
void	setOMRSRepositoryConnector(OMRSRepositoryConnector connector) 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()

Method Detail

getOMRSMetadataCollection

public OMRSMetadataCollection getOMRSMetadataCollection()
                                                 throws MetadataServerUncontactableException

Throws:

MetadataServerUncontactableException

getOMRSRepositoryHelper

public OMRSRepositoryHelper getOMRSRepositoryHelper()

setOMRSRepositoryConnector

public void setOMRSRepositoryConnector(OMRSRepositoryConnector connector)
                                throws MetadataServerUncontactableException

Set the OMRS repository connector

Parameters:

connector - connector cannot be null

Throws:

MetadataServerUncontactableException - Metadata server not contactable

callGetAllTypes

public TypeDefGallery callGetAllTypes(String userId)
                               throws UserNotAuthorizedException,
                                      MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

MetadataServerUncontactableException

callGetTypeDefByName

public TypeDef callGetTypeDefByName(String userId,
                                    String typeName)
                             throws UserNotAuthorizedException,
                                    InvalidParameterException,
                                    MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

MetadataServerUncontactableException

callOMRSAddEntity

public EntityDetail callOMRSAddEntity(String userId,
                                      EntityDetail entityDetail)
                               throws UserNotAuthorizedException,
                                      InvalidParameterException,
                                      ClassificationException,
                                      StatusNotSupportedException,
                                      MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

ClassificationException

StatusNotSupportedException

MetadataServerUncontactableException

callOMRSGetEntityByGuid

public EntityDetail callOMRSGetEntityByGuid(String userId,
                                            String entityGUID)
                                     throws UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

UnrecognizedGUIDException

MetadataServerUncontactableException

callFindEntitiesByPropertyValue

public List<EntityDetail> callFindEntitiesByPropertyValue(String userId,
                                                          String entityTypeGUID,
                                                          String searchCriteria,
                                                          int fromEntityElement,
                                                          List<InstanceStatus> limitResultsByStatus,
                                                          List<String> limitResultsByClassification,
                                                          Date asOfTime,
                                                          String sequencingProperty,
                                                          SequencingOrder sequencingOrder,
                                                          int pageSize)
                                                   throws UserNotAuthorizedException,
                                                          FunctionNotSupportedException,
                                                          InvalidParameterException,
                                                          MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

FunctionNotSupportedException

InvalidParameterException

MetadataServerUncontactableException

callOMRSUpdateEntity

public EntityDetail callOMRSUpdateEntity(String userId,
                                         EntityDetail entityDetail)
                                  throws UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

UnrecognizedGUIDException

MetadataServerUncontactableException

callOMRSDeleteEntity

public EntityDetail callOMRSDeleteEntity(String userId,
                                         String typeDefName,
                                         String typeDefGuid,
                                         String obsoleteGuid)
                                  throws UserNotAuthorizedException,
                                         FunctionNotSupportedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

FunctionNotSupportedException

InvalidParameterException

UnrecognizedGUIDException

MetadataServerUncontactableException

callOMRSPurgeEntity

public void callOMRSPurgeEntity(String userId,
                                String typeDefName,
                                String typeDefGuid,
                                String obsoleteGuid)
                         throws UserNotAuthorizedException,
                                MetadataServerUncontactableException,
                                EntityNotDeletedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                GUIDNotPurgedException

Throws:

UserNotAuthorizedException

MetadataServerUncontactableException

EntityNotDeletedException

InvalidParameterException

UnrecognizedGUIDException

GUIDNotPurgedException

callOMRSRestoreEntity

public EntityDetail callOMRSRestoreEntity(String userId,
                                          String guid)
                                   throws UserNotAuthorizedException,
                                          InvalidParameterException,
                                          FunctionNotSupportedException,
                                          UnrecognizedGUIDException,
                                          MetadataServerUncontactableException,
                                          GUIDNotDeletedException

Throws:

UserNotAuthorizedException

InvalidParameterException

FunctionNotSupportedException

UnrecognizedGUIDException

MetadataServerUncontactableException

GUIDNotDeletedException

callOMRSClassifyEntity

public EntityDetail callOMRSClassifyEntity(String userId,
                                           String entityGUID,
                                           String classificationName,
                                           InstanceProperties instanceProperties)
                                    throws UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException,
                                           MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

ClassificationException

UnrecognizedGUIDException

MetadataServerUncontactableException

callOMRSDeClassifyEntity

public EntityDetail callOMRSDeClassifyEntity(String userId,
                                             String entityGUID,
                                             String classificationName)
                                      throws UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException,
                                             MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

ClassificationException

UnrecognizedGUIDException

MetadataServerUncontactableException

callOMRSAddRelationship

public Relationship callOMRSAddRelationship(String userId,
                                            Relationship relationship)
                                     throws UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            MetadataServerUncontactableException,
                                            StatusNotSupportedException

Throws:

UserNotAuthorizedException

InvalidParameterException

UnrecognizedGUIDException

MetadataServerUncontactableException

StatusNotSupportedException

callOMRSGetRelationshipByGuid

public Relationship callOMRSGetRelationshipByGuid(String userId,
                                                  String relationshipGUID)
                                           throws UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

UnrecognizedGUIDException

MetadataServerUncontactableException

callOMRSUpdateRelationship

public Relationship callOMRSUpdateRelationship(String userId,
                                               Relationship relationship)
                                        throws UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               InvalidParameterException,
                                               StatusNotSupportedException,
                                               UnrecognizedGUIDException

Throws:

UserNotAuthorizedException

MetadataServerUncontactableException

InvalidParameterException

StatusNotSupportedException

UnrecognizedGUIDException

callOMRSDeleteRelationship

public Relationship callOMRSDeleteRelationship(String userId,
                                               String typeGuid,
                                               String typeName,
                                               String guid)
                                        throws UserNotAuthorizedException,
                                               InvalidParameterException,
                                               FunctionNotSupportedException,
                                               UnrecognizedGUIDException,
                                               MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

FunctionNotSupportedException

UnrecognizedGUIDException

MetadataServerUncontactableException

callOMRSRestoreRelationship

public Relationship callOMRSRestoreRelationship(String userId,
                                                String guid)
                                         throws UserNotAuthorizedException,
                                                InvalidParameterException,
                                                FunctionNotSupportedException,
                                                UnrecognizedGUIDException,
                                                MetadataServerUncontactableException,
                                                GUIDNotDeletedException

Throws:

UserNotAuthorizedException

InvalidParameterException

FunctionNotSupportedException

UnrecognizedGUIDException

MetadataServerUncontactableException

GUIDNotDeletedException

callOMRSPurgeRelationship

public void callOMRSPurgeRelationship(String userId,
                                      String typeGuid,
                                      String typeName,
                                      String guid)
                               throws UserNotAuthorizedException,
                                      InvalidParameterException,
                                      GUIDNotPurgedException,
                                      UnrecognizedGUIDException,
                                      MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

GUIDNotPurgedException

UnrecognizedGUIDException

MetadataServerUncontactableException

callGetRelationshipsForEntity

public List<Relationship> callGetRelationshipsForEntity(String userId,
                                                        String entityGUID,
                                                        String relationshipTypeGuid,
                                                        int fromRelationshipElement,
                                                        Date asOfTime,
                                                        String sequencingProperty,
                                                        SequencingOrder sequencingOrder,
                                                        int pageSize)
                                                 throws UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        FunctionNotSupportedException,
                                                        UnrecognizedGUIDException,
                                                        MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

FunctionNotSupportedException

UnrecognizedGUIDException

MetadataServerUncontactableException

callGetRelationshipsForEntity

public List<Relationship> callGetRelationshipsForEntity(String userId,
                                                        String entityGUID,
                                                        String relationshipTypeGUID,
                                                        int fromRelationshipElement,
                                                        List<InstanceStatus> limitResultsByStatus,
                                                        Date asOfTime,
                                                        String sequencingProperty,
                                                        SequencingOrder sequencingOrder,
                                                        int pageSize)
                                                 throws UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        FunctionNotSupportedException,
                                                        UnrecognizedGUIDException,
                                                        MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

FunctionNotSupportedException

UnrecognizedGUIDException

MetadataServerUncontactableException

callGetTypeGuid

public String callGetTypeGuid(String userId,
                              String typeName)
                       throws UserNotAuthorizedException,
                              InvalidParameterException,
                              MetadataServerUncontactableException

Throws:

UserNotAuthorizedException

InvalidParameterException

MetadataServerUncontactableException

callGetEntityNeighbourhood

public InstanceGraph callGetEntityNeighbourhood(String userId,
                                                String entityGUID,
                                                List<String> entityTypeGUIDs,
                                                List<String> relationshipTypeGUIDs,
                                                List<InstanceStatus> limitResultsByStatus,
                                                List<String> limitResultsByClassification,
                                                Date asOfTime,
                                                int level)
                                         throws UserNotAuthorizedException,
                                                MetadataServerUncontactableException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                FunctionNotSupportedException

Throws:

UserNotAuthorizedException

MetadataServerUncontactableException

InvalidParameterException

UnrecognizedGUIDException

FunctionNotSupportedException

findEntitiesByType

public static List<EntityDetail> findEntitiesByType(OMRSAPIHelper oMRSAPIHelper,
                                                    String serverName,
                                                    String userId,
                                                    String type,
                                                    String searchCriteria,
                                                    Date asOfTime,
                                                    Integer offset,
                                                    Integer pageSize,
                                                    SequencingOrder sequencingOrder,
                                                    String sequencingProperty,
                                                    String methodName)
                                             throws MetadataServerUncontactableException,
                                                    InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    FunctionNotSupportedException

Throws:

MetadataServerUncontactableException

InvalidParameterException

UserNotAuthorizedException

FunctionNotSupportedException