Class ProcessHandler<PROCESS,PORT,DATA_FLOW,CONTROL_FLOW,PROCESS_CALL,LINEAGE_MAPPING>
java.lang.Object
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<PROCESS>
org.odpi.openmetadata.commonservices.generichandlers.ProcessHandler<PROCESS,PORT,DATA_FLOW,CONTROL_FLOW,PROCESS_CALL,LINEAGE_MAPPING>
public class ProcessHandler<PROCESS,PORT,DATA_FLOW,CONTROL_FLOW,PROCESS_CALL,LINEAGE_MAPPING>
extends ReferenceableHandler<PROCESS>
ProcessHandler provides the methods to create and maintain processes and their contents.
It does not currently support effectivity dates - but probably should.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
OpenMetadataAPIGenericHandler.AnchorIdentifiers
-
Field Summary
Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler
assetActionDescription, auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, qualifiedNamePropertyNamesList, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones
-
Constructor Summary
ConstructorDescriptionProcessHandler
(OpenMetadataAPIGenericConverter<PROCESS> converter, Class<PROCESS> beanClass, OpenMetadataAPIGenericConverter<PORT> portConverter, Class<PORT> portBeanClass, OpenMetadataAPIGenericConverter<DATA_FLOW> dataFlowConverter, Class<DATA_FLOW> dataFlowBeanClass, OpenMetadataAPIGenericConverter<CONTROL_FLOW> controlFlowConverter, Class<CONTROL_FLOW> controlFlowBeanClass, OpenMetadataAPIGenericConverter<PROCESS_CALL> processCallConverter, Class<PROCESS_CALL> processCallBeanClass, OpenMetadataAPIGenericConverter<LINEAGE_MAPPING> lineageMappingConverter, Class<LINEAGE_MAPPING> lineageMappingClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog) Construct the handler information needed to interact with the repository services -
Method Summary
Modifier and TypeMethodDescriptionvoid
clearControlFlow
(String userId, String externalSourceGUID, String externalSourceName, String controlFlowGUID, String controlFlowGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the control flow relationship between two elements.void
clearDataFlow
(String userId, String externalSourceGUID, String externalSourceName, String dataFlowGUID, String dataFlowGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the data flow relationship between two elements.void
clearLineageMapping
(String userId, String lineageMappingGUID, String lineageMappingGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the lineage mapping relationship.void
clearPortDelegation
(String userId, String externalSourceGUID, String externalSourceName, String portOneGUID, String portOneGUIDParameterName, String portTwoGUID, String portTwoGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the port delegation relationship between two ports.void
clearPortSchemaType
(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String schemaTypeGUID, String schemaTypeGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the schema type from a port.void
clearProcessCall
(String userId, String externalSourceGUID, String externalSourceName, String processCallGUID, String processCallGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the process call relationship.void
clearProcessParent
(String userId, String externalSourceGUID, String externalSourceName, String parentProcessGUID, String parentProcessGUIDParameterName, String childProcessGUID, String childProcessGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove a parent-child relationship between two processes.void
clearProcessPort
(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Unlink a port from a process.createPort
(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String qualifiedName, String displayName, int portType, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, Object> extendedProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Create a new metadata element to represent a port.createProcess
(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String name, String resourceName, String versionIdentifier, String technicalDescription, String deployedImplementationType, String formula, String formulaType, String implementationLanguage, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, Object> suppliedExtendedProperties, InstanceStatus initialStatus, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) Create a new metadata element to represent a process.createProcessFromTemplate
(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String templateGUIDParameterName, String qualifiedName, String qualifiedNameParameterName, String technicalName, String versionIdentifier, String description, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Create a new metadata element to represent a process using an existing metadata element as a template.findPorts
(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of port metadata elements that contain the search string.findProcesses
(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of process metadata elements that contain the search string.getControlFlow
(String userId, String currentStepGUID, String currentStepGUIDParameterName, String nextStepGUID, String nextStepGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the control flow relationship between two elements.getControlFlowNextSteps
(String userId, String currentStepGUID, String currentStepGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the control relationships linked from a specific element to the possible next elements in the process.getControlFlowPreviousSteps
(String userId, String currentStepGUID, String currentStepGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the control relationships linked from a specific element to the possible previous elements in the process.getDataFlow
(String userId, String dataSupplierGUID, String dataSupplierGUIDParameterName, String dataConsumerGUID, String dataConsumerGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the data flow relationship between two elements.getDataFlowConsumers
(String userId, String dataSupplierGUID, String dataSupplierGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the data flow relationships linked from a specific element to the downstream consumers.getDataFlowSuppliers
(String userId, String dataConsumerGUID, String dataConsumerGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the data flow relationships linked from a specific element to the upstream suppliers.getDestinationLineageMappings
(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the lineage mapping relationships linked from a specific source element to its destinations.getLineageMapping
(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, String destinationElementGUID, String destinationElementGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the lineage mapping relationship between two elements.getPortByGUID
(String userId, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the port metadata element with the supplied unique identifier.getPortDelegation
(String userId, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the port that this port delegates to.getPortsByName
(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of port metadata elements with a matching qualified or display name.getPortsForProcess
(String userId, String processGUID, String processGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of ports associated with a process.getPortUse
(String userId, String portGUID, String portGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of ports that delegate to this port.getProcessByGUID
(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the process metadata element with the supplied unique identifier.getProcessCall
(String userId, String callerGUID, String callerGUIDParameterName, String calledGUID, String calledGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the process call relationship between two elements.getProcessCalled
(String userId, String callerGUID, String callerGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the process call relationships linked from a specific element to the elements it calls.getProcessCallers
(String userId, String calledGUID, String calledGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the process call relationships linked from a specific element to its callers.getProcessesByName
(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of process metadata elements with a matching qualified or display name.getProcessParent
(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the process metadata element with the supplied unique identifier.getSourceLineageMappings
(String userId, String destinationElementGUID, String destinationElementGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the lineage mapping relationships linked from a specific destination element to its sources.getSubProcesses
(String userId, String processGUID, String processGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the process metadata element with the supplied unique identifier.void
publishProcess
(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the zones for the process so that it becomes visible to consumers.void
removePort
(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the metadata element representing a port.void
removeProcess
(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the metadata element representing a process.setupControlFlow
(String userId, String externalSourceGUID, String externalSourceName, String currentStepGUID, String currentStepGUIDParameterName, String nextStepGUID, String nextStepGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String guard, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Link two elements to show that when one completes the next is started.setupDataFlow
(String userId, String externalSourceGUID, String externalSourceName, String dataSupplierGUID, String dataSupplierGUIDParameterName, String dataConsumerGUID, String dataConsumerGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Link two elements together to show that data flows from one to the other.setupLineageMapping
(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, String destinationElementGUID, String destinationElementGUIDParameterName, String qualifiedName, String label, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Link to elements together to show that they are part of the lineage of the data that is moving between the processes.void
setupPortDelegation
(String userId, String externalSourceGUID, String externalSourceName, String portOneGUID, String portOneGUIDParameterName, String portTwoGUID, String portTwoGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Link two ports together to show that portTwo is an implementation of portOne.void
setupPortSchemaType
(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String schemaTypeGUID, String schemaTypeGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Link a schema type to a port to show the structure of data it accepts.setupProcessCall
(String userId, String externalSourceGUID, String externalSourceName, String callerGUID, String callerGUIDParameterName, String calledGUID, String calledGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Link two elements together to show a request-response call between them.void
setupProcessParent
(String userId, String externalSourceGUID, String externalSourceName, String parentProcessGUID, String parentProcessGUIDParameterName, String childProcessGUID, String childProcessGUIDParameterName, Date effectiveFrom, Date effectiveTo, int containmentType, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Create a parent-child relationship between two processes.void
setupProcessPort
(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String portGUID, String portGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Link a port to a process.void
updateControlFlow
(String userId, String externalSourceGUID, String externalSourceName, String controlFlowGUID, String controlFlowGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String guard, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the relationship between two elements that shows that when one completes the next is started.void
updateDataFlow
(String userId, String externalSourceGUID, String externalSourceName, String dataFlowGUID, String dataFlowGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update relationship between two elements that shows that data flows from one to the other.void
updateLineageMapping
(String userId, String lineageMappingGUID, String lineageMappingGUIDParameterName, String qualifiedName, String label, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the relationship between two elements that shows a request-response call between them.void
updatePort
(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String qualifiedName, String displayName, int portType, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, Object> extendedProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the properties of the metadata element representing a port.void
updateProcess
(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, boolean isMergeUpdate, String qualifiedName, String name, String resourceName, String versionIdentifier, String technicalDescription, String deployedImplementationType, String formula, String implementationLanguage, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, Object> suppliedExtendedProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the metadata element representing a process.void
updateProcessCall
(String userId, String externalSourceGUID, String externalSourceName, String processCallGUID, String processCallGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the relationship between two elements that shows a request-response call between them.void
updateProcessStatus
(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, InstanceStatus processStatus, String processStatusParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the status of the metadata element representing a process.void
withdrawProcess
(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the zones for the process so that it is no longer visible to consumers.Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
addAssignmentScope, addDataFieldValuesClassification, addGovernanceActionClassification, addGovernanceDefinitionScope, addGovernanceExpectationsClassification, addGovernanceMeasurementsClassification, addGovernedBy, addImplementedBy, addMoreInformation, addOwner, addRetentionClassification, addSecurityTags, addStakeholder, addSubjectAreaClassification, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getAssignedActors, getAssignmentScope, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCatalogTemplateList, getCollectionMembers, getCommissionedByStakeholder, getDataFieldValuesClassifiedElement, getDescriptiveElements, getElementsSourceFrom, getEntityByUniqueQualifiedName, getGovernanceActionClassifiedElements, getGovernanceDefinitionScope, getGovernedElements, getMeanings, getMoreInformation, getMoreInformation, getOwnersElements, getReferenceValueAssignees, getResourceList, getRetentionClassifiedElements, getSecurityTagsClassifiedElements, getSemanticAssignments, getSourceElements, getStakeholders, getSubjectAreaMembers, getSubjectAreaMembers, getSupportedByResource, getSupportedByTemplate, getValidValueConsumers, getVendorProperties, linkConsolidatedDuplicate, linkElementsAsPeerDuplicates, removeAssignmentScope, removeCatalogTemplate, removeDataFieldValuesClassification, removeGovernanceActionClassification, removeGovernanceDefinitionScope, removeGovernanceExpectationsClassification, removeGovernanceMeasurementsClassification, removeGovernedBy, removeImplementedBy, removeMoreInformation, removeOwner, removeResourceListMember, removeRetentionClassification, removeSecurityTags, removeSemanticAssignment, removeStakeholder, removeSubjectAreaClassification, removeTemplateClassification, saveCatalogTemplate, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, saveSemanticAssignments, setBusinessSignificant, setVendorProperties, unlinkElementsAsPeerDuplicates
Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler
createBeanFromTemplate, createBeanFromTemplate
Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
addAnchorGUIDToBuilder, addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanInRepository, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, findEntities, findEntities, findEntities, getAllAttachmentLinks, getAnchorGUIDFromAnchorsClassification, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntitiesFromUser, getAttachedEntity, getAttachedEntity, getAttachedEntityFromUser, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getAttachmentsForType, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanHistory, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getDomainName, getDomainName, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getSpecification, getSupplementaryProperties, getUniqueAttachmentLink, getUniqueAttachmentLink, isBeanIsolated, isEntityATypeOf, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, uncheckedLinkElementToElement, undoBeanUpdateInRepository, undoBeanUpdateInRepository, undoBeanUpdateInRepository, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipEffectivityDates, updateRelationshipProperties, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, validateUniqueProperty, verifyExternalSourceIdentity
Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler
getConverter, getElementStub, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getSupportedZones, getTypeDefByName, setSecurityVerifier
-
Constructor Details
-
ProcessHandler
public ProcessHandler(OpenMetadataAPIGenericConverter<PROCESS> converter, Class<PROCESS> beanClass, OpenMetadataAPIGenericConverter<PORT> portConverter, Class<PORT> portBeanClass, OpenMetadataAPIGenericConverter<DATA_FLOW> dataFlowConverter, Class<DATA_FLOW> dataFlowBeanClass, OpenMetadataAPIGenericConverter<CONTROL_FLOW> controlFlowConverter, Class<CONTROL_FLOW> controlFlowBeanClass, OpenMetadataAPIGenericConverter<PROCESS_CALL> processCallConverter, Class<PROCESS_CALL> processCallBeanClass, OpenMetadataAPIGenericConverter<LINEAGE_MAPPING> lineageMappingConverter, Class<LINEAGE_MAPPING> lineageMappingClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog) Construct the handler information needed to interact with the repository services- Parameters:
converter
- specific converter for the PROCESS bean classbeanClass
- name of bean class that is represented by the generic class PROCESSportConverter
- specific converter for the PORT bean classportBeanClass
- name of bean class that is represented by the generic class PORTdataFlowConverter
- specific converter for the DATA_FLOW bean classdataFlowBeanClass
- name of bean class that is represented by the generic class DATA_FLOWcontrolFlowConverter
- specific converter for the CONTROL_FLOW bean classcontrolFlowBeanClass
- name of bean class that is represented by the generic class CONTROL_FLOWprocessCallConverter
- specific converter for the PROCESS_CALL bean classprocessCallBeanClass
- name of bean class that is represented by the generic class PROCESS_CALLlineageMappingConverter
- specific converter for the LINEAGE_MAPPING bean classlineageMappingClass
- name of bean class that is represented by the generic class LINEAGE_MAPPINGserviceName
- name of this serviceserverName
- name of the local serverinvalidParameterHandler
- handler for managing parameter errorsrepositoryHandler
- manages calls to the repository servicesrepositoryHelper
- provides utilities for manipulating the repository services objectslocalServerUserId
- userId for this serversecurityVerifier
- open metadata security services verifiersupportedZones
- list of zones that the access service is allowed to serve Asset instances from.defaultZones
- list of zones that the access service should set in all new Asset instances.publishZones
- list of zones that the access service sets up in published Asset instances.auditLog
- destination for audit log events.
-
-
Method Details
-
createProcess
public String createProcess(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String name, String resourceName, String versionIdentifier, String technicalDescription, String deployedImplementationType, String formula, String formulaType, String implementationLanguage, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionObject> suppliedExtendedProperties, InstanceStatus initialStatus, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) Create a new metadata element to represent a process.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerqualifiedName
- unique name for this assetname
- the short name property for the processresourceName
- the full name property for the processversionIdentifier
- the stored version identifier property for the processtechnicalDescription
- the stored description property associated with the processdeployedImplementationType
- technology typeformula
- the formula that characterize the processing behavior of the processformulaType
- the language of the formulaimplementationLanguage
- the implementation language used to create the processadditionalProperties
- any arbitrary properties not part of the type systemsuppliedTypeName
- name of the type that is a subtype of asset - or null to create standard typesuppliedExtendedProperties
- properties from any subtypeinitialStatus
- status value for the new process (default = ACTIVE)effectiveFrom
- starting time for this relationship (null for all time)effectiveTo
- ending time for this relationship (null for all time)effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier of the new process
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createProcessFromTemplate
public String createProcessFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String templateGUIDParameterName, String qualifiedName, String qualifiedNameParameterName, String technicalName, String versionIdentifier, String description, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a process using an existing metadata element as a template.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callertemplateGUID
- unique identifier of the metadata element to copytemplateGUIDParameterName
- parameter supplying templateGUIDqualifiedName
- unique name for the term - used in other configurationqualifiedNameParameterName
- parameter supplying qualifiedNametechnicalName
- short name for the processversionIdentifier
- version identifier for the processdescription
- description of the processforLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicateeffectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier of the new process
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateProcess
public void updateProcess(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, boolean isMergeUpdate, String qualifiedName, String name, String resourceName, String versionIdentifier, String technicalDescription, String deployedImplementationType, String formula, String implementationLanguage, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionObject> suppliedExtendedProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the metadata element representing a process.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerprocessGUID
- unique identifier of the metadata element to updateprocessGUIDParameterName
- unique identifier of the process in the external process managerisMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?qualifiedName
- unique name for this assetname
- the display name property for the processresourceName
- the full name property for the processversionIdentifier
- version identifier for the processtechnicalDescription
- the stored description property associated with the processdeployedImplementationType
- technology typeformula
- the formula that characterize the processing behavior of the processimplementationLanguage
- the implementation language used to create the processadditionalProperties
- any arbitrary properties not part of the type systemsuppliedTypeName
- name of the type that is a subtype of asset - or null to create standard typesuppliedExtendedProperties
- properties from any subtypeeffectiveFrom
- time when this process becomes visible to queries - null for any timeeffectiveTo
- time when this process stops being visible to queries - null for neverforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateProcessStatus
public void updateProcessStatus(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, InstanceStatus processStatus, String processStatusParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the status of the metadata element representing a process.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerprocessGUID
- unique identifier of the process to updateprocessGUIDParameterName
- unique identifier of the process in the external process managerprocessStatus
- new status for the processprocessStatusParameterName
- parameter supplying processStatusforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupProcessParent
public void setupProcessParent(String userId, String externalSourceGUID, String externalSourceName, String parentProcessGUID, String parentProcessGUIDParameterName, String childProcessGUID, String childProcessGUIDParameterName, Date effectiveFrom, Date effectiveTo, int containmentType, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a parent-child relationship between two processes.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerparentProcessGUID
- unique identifier of the process in the external process manager that is to be the parent processparentProcessGUIDParameterName
- parameter supplying parentProcessGUIDchildProcessGUID
- unique identifier of the process in the external process manager that is to be the nested sub-processchildProcessGUIDParameterName
- parameter supplying childProcessGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedcontainmentType
- describes the ownership of the sub-processforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearProcessParent
public void clearProcessParent(String userId, String externalSourceGUID, String externalSourceName, String parentProcessGUID, String parentProcessGUIDParameterName, String childProcessGUID, String childProcessGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove a parent-child relationship between two processes.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerparentProcessGUID
- unique identifier of the process in the external process manager that is to be the parent processparentProcessGUIDParameterName
- parameter supplying parentProcessGUIDchildProcessGUID
- unique identifier of the process in the external process manager that is to be the nested sub-processchildProcessGUIDParameterName
- parameter supplying childProcessGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
publishProcess
public void publishProcess(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the zones for the process so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Asset Manager OMAS).- Parameters:
userId
- calling userprocessGUID
- unique identifier of the metadata element to publishprocessGUIDParameterName
- parameter supplying processGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
withdrawProcess
public void withdrawProcess(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the zones for the process so that it is no longer visible to consumers.- Parameters:
userId
- calling userprocessGUID
- unique identifier of the metadata element to withdrawprocessGUIDParameterName
- parameter supplying processGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeProcess
public void removeProcess(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element representing a process.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerprocessGUID
- unique identifier of the metadata element to removeprocessGUIDParameterName
- unique identifier of the process in the external process managerforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
findProcesses
public List<PROCESS> findProcesses(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of process metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
userId
- calling usersearchString
- string to find in the propertiessearchStringParameterName
- parameter supplying searchStringstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getProcessesByName
public List<PROCESS> getProcessesByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
userId
- calling username
- name to search fornameParameterName
- parameter supplying namestartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getProcessByGUID
public PROCESS getProcessByGUID(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the process metadata element with the supplied unique identifier.- Parameters:
userId
- calling userprocessGUID
- unique identifier of the requested metadata elementprocessGUIDParameterName
- parameter supplying processGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- requested metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getProcessParent
public PROCESS getProcessParent(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the process metadata element with the supplied unique identifier.- Parameters:
userId
- calling userprocessGUID
- unique identifier of the requested metadata elementprocessGUIDParameterName
- parameter supplying processGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- parent process element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getSubProcesses
public List<PROCESS> getSubProcesses(String userId, String processGUID, String processGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the process metadata element with the supplied unique identifier.- Parameters:
userId
- calling userprocessGUID
- unique identifier of the requested metadata elementprocessGUIDParameterName
- parameter supplying processGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of process element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createPort
public String createPort(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String qualifiedName, String displayName, int portType, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionObject> extendedProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Create a new metadata element to represent a port.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerprocessGUID
- unique identifier of the process where the port is locatedprocessGUIDParameterName
- parameter supplying processGUIDqualifiedName
- unique name for the port - used in other configurationdisplayName
- short display name for the portportType
- description of the portadditionalProperties
- additional properties for a portsuppliedTypeName
- type name from the caller (enables creation of subtypes)extendedProperties
- properties for a port subtypeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier of the new metadata element for the port
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updatePort
public void updatePort(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String qualifiedName, String displayName, int portType, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionObject> extendedProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Update the properties of the metadata element representing a port. This call replaces all existing properties with the supplied properties.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerportGUID
- unique identifier of the port to updateportGUIDParameterName
- parameter supplying portGUIDqualifiedName
- unique name for the port - used in other configurationdisplayName
- short display name for the portportType
- description of the portadditionalProperties
- additional properties for a portsuppliedTypeName
- type name from the caller (enables creation of subtypes)extendedProperties
- properties for a port subtypeeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupProcessPort
public void setupProcessPort(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String portGUID, String portGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Link a port to a process.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerprocessGUID
- unique identifier of the processprocessGUIDParameterName
- parameter supplying processGUIDportGUID
- unique identifier of the portportGUIDParameterName
- parameter supplying portGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearProcessPort
public void clearProcessPort(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Unlink a port from a process.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerprocessGUID
- unique identifier of the processprocessGUIDParameterName
- parameter supplying processGUIDportGUID
- unique identifier of the portportGUIDParameterName
- parameter supplying portGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupPortDelegation
public void setupPortDelegation(String userId, String externalSourceGUID, String externalSourceName, String portOneGUID, String portOneGUIDParameterName, String portTwoGUID, String portTwoGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Link two ports together to show that portTwo is an implementation of portOne. (That is, portOne delegates to portTwo.)- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerportOneGUID
- unique identifier of the port at end 1portOneGUIDParameterName
- parameter supplying portOneGUIDportTwoGUID
- unique identifier of the port at end 2portTwoGUIDParameterName
- parameter supplying portTwoGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearPortDelegation
public void clearPortDelegation(String userId, String externalSourceGUID, String externalSourceName, String portOneGUID, String portOneGUIDParameterName, String portTwoGUID, String portTwoGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the port delegation relationship between two ports.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerportOneGUID
- unique identifier of the port at end 1portOneGUIDParameterName
- parameter supplying portOneGUIDportTwoGUID
- unique identifier of the port at end 2portTwoGUIDParameterName
- parameter supplying portTwoGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupPortSchemaType
public void setupPortSchemaType(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String schemaTypeGUID, String schemaTypeGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Link a schema type to a port to show the structure of data it accepts.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerportGUID
- unique identifier of the portportGUIDParameterName
- parameter supplying portGUIDschemaTypeGUID
- unique identifier of the schemaTypeschemaTypeGUIDParameterName
- parameter supplying schemaTypeGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearPortSchemaType
public void clearPortSchemaType(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String schemaTypeGUID, String schemaTypeGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the schema type from a port.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerportGUID
- unique identifier of the portportGUIDParameterName
- parameter supplying portGUIDschemaTypeGUID
- unique identifier of the schemaTypeschemaTypeGUIDParameterName
- parameter supplying schemaTypeGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removePort
public void removePort(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element representing a port.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerportGUID
- unique identifier of the metadata element to removeportGUIDParameterName
- parameter supplying portGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
findPorts
public List<PORT> findPorts(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of port metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
userId
- calling usersearchString
- string to find in the propertiessearchStringParameterName
- parameter supplying searchStringstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getPortsForProcess
public List<PORT> getPortsForProcess(String userId, String processGUID, String processGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of ports associated with a process.- Parameters:
userId
- calling userprocessGUID
- unique identifier of the process of interestprocessGUIDParameterName
- parameter passing processGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of associated metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getPortUse
public List<PORT> getPortUse(String userId, String portGUID, String portGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of ports that delegate to this port.- Parameters:
userId
- calling userportGUID
- unique identifier of the starting portportGUIDParameterName
- parameter passing portGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of associated metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getPortDelegation
public PORT getPortDelegation(String userId, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the port that this port delegates to.- Parameters:
userId
- calling userportGUID
- unique identifier of the starting port aliasportGUIDParameterName
- parameter passing portGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- matching metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getPortsByName
public List<PORT> getPortsByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of port metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
userId
- calling username
- name to search fornameParameterName
- parameter supplying namestartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getPortByGUID
public PORT getPortByGUID(String userId, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the port metadata element with the supplied unique identifier.- Parameters:
userId
- calling userportGUID
- unique identifier of the requested metadata elementportGUIDParameterName
- parameter passing portGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- matching metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupDataFlow
public String setupDataFlow(String userId, String externalSourceGUID, String externalSourceName, String dataSupplierGUID, String dataSupplierGUIDParameterName, String dataConsumerGUID, String dataConsumerGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Link two elements together to show that data flows from one to the other.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerdataSupplierGUID
- unique identifier of the data supplierdataSupplierGUIDParameterName
- parameter supplying dataSupplierGUIDdataConsumerGUID
- unique identifier of the data consumerdataConsumerGUIDParameterName
- parameter supplying dataConsumerGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedqualifiedName
- unique identifier for the information supply chainlabel
- label for the visualization of the relationshipdescription
- description and/or purpose of the data flowformula
- function that determines the subset of the data that flowsforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataFlow
public DATA_FLOW getDataFlow(String userId, String dataSupplierGUID, String dataSupplierGUIDParameterName, String dataConsumerGUID, String dataConsumerGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the data flow relationship between two elements. The qualifiedName is optional unless there is more than one data flow relationships between these two elements since it is used to disambiguate the request.- Parameters:
userId
- calling userdataSupplierGUID
- unique identifier of the data supplierdataSupplierGUIDParameterName
- parameter supplying dataSupplierGUIDdataConsumerGUID
- unique identifier of the data consumerdataConsumerGUIDParameterName
- parameter supplying dataConsumerGUIDqualifiedName
- unique identifier for the information supply chainforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- time when the relationship is effectivemethodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateDataFlow
public void updateDataFlow(String userId, String externalSourceGUID, String externalSourceName, String dataFlowGUID, String dataFlowGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update relationship between two elements that shows that data flows from one to the other.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerdataFlowGUID
- unique identifier of the data flow relationshipdataFlowGUIDParameterName
- parameter supplying dataFlowGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedqualifiedName
- unique identifier for the information supply chainlabel
- label for the visualization of the relationshipdescription
- description and/or purpose of the data flowformula
- function that determines the subset of the data that flowsforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearDataFlow
public void clearDataFlow(String userId, String externalSourceGUID, String externalSourceName, String dataFlowGUID, String dataFlowGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the data flow relationship between two elements.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerdataFlowGUID
- unique identifier of the data flow relationshipdataFlowGUIDParameterName
- parameter supplying dataFlowGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataFlowConsumers
public List<DATA_FLOW> getDataFlowConsumers(String userId, String dataSupplierGUID, String dataSupplierGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the data flow relationships linked from a specific element to the downstream consumers.- Parameters:
userId
- calling userdataSupplierGUID
- unique identifier of the data supplierdataSupplierGUIDParameterName
- parameter supplying dataSupplierGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataFlowSuppliers
public List<DATA_FLOW> getDataFlowSuppliers(String userId, String dataConsumerGUID, String dataConsumerGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the data flow relationships linked from a specific element to the upstream suppliers.- Parameters:
userId
- calling userdataConsumerGUID
- unique identifier of the data consumerdataConsumerGUIDParameterName
- parameter supplying dataConsumerGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupControlFlow
public String setupControlFlow(String userId, String externalSourceGUID, String externalSourceName, String currentStepGUID, String currentStepGUIDParameterName, String nextStepGUID, String nextStepGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String guard, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Link two elements to show that when one completes the next is started.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callercurrentStepGUID
- unique identifier of the previous stepcurrentStepGUIDParameterName
- parameter supplying currentStepGUIDnextStepGUID
- unique identifier of the next stepnextStepGUIDParameterName
- parameter supplying nextStepGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedqualifiedName
- unique identifier for the information supply chainlabel
- label for the visualization of the relationshipdescription
- description and/or purpose of the control flowguard
- function that must be true to travel down this control flowforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier for the control flow relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getControlFlow
public CONTROL_FLOW getControlFlow(String userId, String currentStepGUID, String currentStepGUIDParameterName, String nextStepGUID, String nextStepGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the control flow relationship between two elements. The qualifiedName is optional unless there is more than one control flow relationships between these two elements since it is used to disambiguate the request.- Parameters:
userId
- calling usercurrentStepGUID
- unique identifier of the previous stepcurrentStepGUIDParameterName
- parameter supplying currentStepGUIDnextStepGUID
- unique identifier of the next stepnextStepGUIDParameterName
- parameter supplying nextStepGUIDqualifiedName
- unique identifier for the information supply chainforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateControlFlow
public void updateControlFlow(String userId, String externalSourceGUID, String externalSourceName, String controlFlowGUID, String controlFlowGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String guard, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the relationship between two elements that shows that when one completes the next is started.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callercontrolFlowGUID
- unique identifier of the control flow relationshipcontrolFlowGUIDParameterName
- parameter supplying controlFlowGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedqualifiedName
- unique identifier for the information supply chainlabel
- label for the visualization of the relationshipdescription
- description and/or purpose of the control flowguard
- function that must be true to travel down this control flowforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearControlFlow
public void clearControlFlow(String userId, String externalSourceGUID, String externalSourceName, String controlFlowGUID, String controlFlowGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the control flow relationship between two elements.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callercontrolFlowGUID
- unique identifier of the control flow relationshipcontrolFlowGUIDParameterName
- parameter supplying controlFlowGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getControlFlowNextSteps
public List<CONTROL_FLOW> getControlFlowNextSteps(String userId, String currentStepGUID, String currentStepGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the control relationships linked from a specific element to the possible next elements in the process.- Parameters:
userId
- calling usercurrentStepGUID
- unique identifier of the current stepcurrentStepGUIDParameterName
- parameter supplying currentStepGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getControlFlowPreviousSteps
public List<CONTROL_FLOW> getControlFlowPreviousSteps(String userId, String currentStepGUID, String currentStepGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the control relationships linked from a specific element to the possible previous elements in the process.- Parameters:
userId
- calling usercurrentStepGUID
- unique identifier of the current stepcurrentStepGUIDParameterName
- parameter supplying currentStepGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupProcessCall
public String setupProcessCall(String userId, String externalSourceGUID, String externalSourceName, String callerGUID, String callerGUIDParameterName, String calledGUID, String calledGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Link two elements together to show a request-response call between them.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callercallerGUID
- unique identifier of the element that is making the callcallerGUIDParameterName
- parameter supplying callerGUIDcalledGUID
- unique identifier of the element that is processing the callcalledGUIDParameterName
- parameter supplying calledGUIDqualifiedName
- unique identifier for the information supply chainlabel
- label for the visualization of the relationshipdescription
- description and/or purpose of the process callformula
- function that determines the subset of the data that flowseffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier of the new relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getProcessCall
public PROCESS_CALL getProcessCall(String userId, String callerGUID, String callerGUIDParameterName, String calledGUID, String calledGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the process call relationship between two elements. The qualifiedName is optional unless there is more than one process call relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.- Parameters:
userId
- calling usercallerGUID
- unique identifier of the element that is making the callcallerGUIDParameterName
- parameter supplying callerGUIDcalledGUID
- unique identifier of the element that is processing the callcalledGUIDParameterName
- parameter supplying calledGUIDqualifiedName
- unique identifier for the information supply chainforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateProcessCall
public void updateProcessCall(String userId, String externalSourceGUID, String externalSourceName, String processCallGUID, String processCallGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the relationship between two elements that shows a request-response call between them.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerprocessCallGUID
- unique identifier of the process call relationshipprocessCallGUIDParameterName
- parameter supplying processCallGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedqualifiedName
- unique identifier for the information supply chainlabel
- label for the visualization of the relationshipdescription
- description and/or purpose of the process callformula
- function that determines the subset of the data that flowsforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearProcessCall
public void clearProcessCall(String userId, String externalSourceGUID, String externalSourceName, String processCallGUID, String processCallGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the process call relationship.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerprocessCallGUID
- unique identifier of the process call relationshipprocessCallGUIDParameterName
- parameter supplying processCallGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getProcessCalled
public List<PROCESS_CALL> getProcessCalled(String userId, String callerGUID, String callerGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the process call relationships linked from a specific element to the elements it calls.- Parameters:
userId
- calling usercallerGUID
- unique identifier of the element that is making the callcallerGUIDParameterName
- parameter supplying callerGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getProcessCallers
public List<PROCESS_CALL> getProcessCallers(String userId, String calledGUID, String calledGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the process call relationships linked from a specific element to its callers.- Parameters:
userId
- calling usercalledGUID
- unique identifier of the element that is processing the callcalledGUIDParameterName
- parameter supplying calledGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupLineageMapping
public String setupLineageMapping(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, String destinationElementGUID, String destinationElementGUIDParameterName, String qualifiedName, String label, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Link to elements together to show that they are part of the lineage of the data that is moving between the processes. Typically, the lineage relationships stitch together processes and data assets supported by different technologies.- Parameters:
userId
- calling usersourceElementGUID
- unique identifier of the sourcesourceElementGUIDParameterName
- parameter supplying sourceElementGUIDdestinationElementGUID
- unique identifier of the destinationdestinationElementGUIDParameterName
- parameter supplying destinationElementGUIDqualifiedName
- unique identifier for the information supply chainlabel
- label for the visualization of the relationshipdescription
- description and/or purpose of the mappingeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier of the new relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getLineageMapping
public LINEAGE_MAPPING getLineageMapping(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, String destinationElementGUID, String destinationElementGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the lineage mapping relationship between two elements. The qualifiedName is optional unless there is more than one lineage mapping relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.- Parameters:
userId
- calling usersourceElementGUID
- unique identifier of the sourcesourceElementGUIDParameterName
- parameter supplying sourceElementGUIDdestinationElementGUID
- unique identifier of the destinationdestinationElementGUIDParameterName
- parameter supplying destinationElementGUIDqualifiedName
- unique identifier for the information supply chainforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateLineageMapping
public void updateLineageMapping(String userId, String lineageMappingGUID, String lineageMappingGUIDParameterName, String qualifiedName, String label, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the relationship between two elements that shows a request-response call between them.- Parameters:
userId
- calling userlineageMappingGUID
- unique identifier of the process call relationshiplineageMappingGUIDParameterName
- parameter supplying lineageMappingGUIDeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedqualifiedName
- unique identifier for the information supply chainlabel
- label for the visualization of the relationshipdescription
- description and/or purpose of the mappingforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
clearLineageMapping
public void clearLineageMapping(String userId, String lineageMappingGUID, String lineageMappingGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the lineage mapping relationship.- Parameters:
userId
- calling userlineageMappingGUID
- unique identifier of the lineage mapping relationshiplineageMappingGUIDParameterName
- parameter supplying lineageMappingGUIDforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDestinationLineageMappings
public List<LINEAGE_MAPPING> getDestinationLineageMappings(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the lineage mapping relationships linked from a specific source element to its destinations.- Parameters:
userId
- calling usersourceElementGUID
- unique identifier of the sourcesourceElementGUIDParameterName
- parameter supplying sourceElementGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of lineage mapping relationships
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getSourceLineageMappings
public List<LINEAGE_MAPPING> getSourceLineageMappings(String userId, String destinationElementGUID, String destinationElementGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the lineage mapping relationships linked from a specific destination element to its sources.- Parameters:
userId
- calling userdestinationElementGUID
- unique identifier of the destinationdestinationElementGUIDParameterName
- parameter supplying destinationElementGUIDstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?effectiveTime
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)methodName
- calling method- Returns:
- list of lineage mapping relationships
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-