Class ConnectorTypeHandler<B>
java.lang.Object
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIAnchorHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPITemplateHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<B>
org.odpi.openmetadata.commonservices.generichandlers.ConnectorTypeHandler<B>
ConnectorTypeHandler manages ConnectorType objects. These describe the information necessary to construct a connector. They are used by
connection objects to describe the connector provider for the connector.
ConnectorTypeHandler runs server-side in the OMAG Server Platform and retrieves ConnectorType entities through the OMRSRepositoryConnector via the
generic handler and repository handler.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIAnchorHandler
OpenMetadataAPIAnchorHandler.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
ConstructorsConstructorDescriptionConnectorTypeHandler
(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, 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 TypeMethodDescriptioncreateConnectorType
(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String supportedDeployedImplementationType, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, Object> extendedProperties, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) Creates a new connectorType and returns the unique identifier for it.createConnectorTypeFromTemplate
(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String qualifiedName, String displayName, String description, String methodName) Create a new metadata element to represent a connection using an existing metadata element as a template.findConnectorTypes
(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of metadata elements that contain the search string.getConnectorTypeByGUID
(String userId, String guid, String guidParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the metadata element with the supplied unique identifier.getConnectorTypeForAsset
(String userId, String supportedAssetTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieves the connector type for the named asset type and if found, returns its unique identifier.getConnectorTypeForConnection
(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String supportedDeployedImplementationType, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String, String> additionalProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieves the connector type for the qualified name and if found, returns its unique identifier.getConnectorTypesByName
(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Retrieve the list of metadata elements with a matching qualified name, display name or connector provider class name.void
removeConnectorType
(String userId, String externalSourceGUID, String externalSourceName, String guid, String guidParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Remove the metadata element.void
updateConnectorType
(String userId, String externalSourceGUID, String externalSourceName, String connectorTypeGUID, String connectorTypeGUIDParameterName, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String supportedDeployedImplementationType, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, Object> extendedProperties, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Updates the properties of an existing connectorType.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, getAssignedActors, getAssignmentScope, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, 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, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanInRepository, createBeanInRepository, deleteAnchoredEntity, deleteBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, deleteRelationship, findAttachmentLinks, findBeans, findBeans, findBeans, findEntities, findEntities, findEntities, findEntities, getAllAttachmentLinks, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLink, getAttachmentLink, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanHistory, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRelationshipHistory, getSpecification, getSupplementaryProperties, getUniqueAttachmentLink, getUniqueAttachmentLink, getValidatedBeans, getValidatedEntities, getValidatedEntities, linkElementToElement, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, multiLinkElementToElement, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, setClassificationInRepository, uncheckedLinkElementToElement, undoBeanUpdateInRepository, undoBeanUpdateInRepository, undoBeanUpdateInRepository, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorGUID, validateEntitiesAndAnchorsForRead, validateEntityAndAnchorForRead, validateEntityAndAnchorForRead, validateRelationship, validateUniqueProperty, verifyExternalSourceIdentity, visibleToUserThroughRelationship
Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIAnchorHandler
addAnchorsClassification, getAnchorGUIDForEntity, getAnchorGUIDFromAnchorsClassification, getDomainName, getDomainName
Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIRootHandler
getConverter, getElementStub, getRepositoryHandler, getRepositoryHelper, getServerName, getServiceName, getSupportedZones, getTypeDefByName, setSecurityVerifier
-
Constructor Details
-
ConnectorTypeHandler
public ConnectorTypeHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, 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 this bean classbeanClass
- name of bean class that is represented by the generic class BserviceName
- 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
-
createConnectorType
public String createConnectorType(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String supportedDeployedImplementationType, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, throws InvalidParameterException, PropertyServerException, UserNotAuthorizedExceptionObject> extendedProperties, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) Creates a new connectorType and returns the unique identifier for it.- Parameters:
userId
- userId of user making requestexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external sourceanchorGUID
- unique identifier of the anchor entity (or null if freestanding)qualifiedName
- unique name of the connectorTypedisplayName
- human memorable name for the connectorType - does not need to be uniquedescription
- (optional) description of the connectorType. Setting a description, particularly in a public connectorType makes the connectorType more valuable to other users and can act as an embryonic glossary termsupportedAssetTypeName
- the type of asset that the connector implementation supportssupportedDeployedImplementationType
- the deployed implementation type that the connector implementation supportsexpectedDataFormat
- the format of the data that the connector supports - null for "any"connectorProviderClassName
- class name of the connector providerconnectorFrameworkName
- name of the connector framework that the connector implements - default Open Connector Framework (OCF)connectorInterfaceLanguage
- the language that the connector is implemented in - default JavaconnectorInterfaces
- list of interfaces that the connector supportstargetTechnologySource
- the organization that supplies the target technology that the connector implementation connects totargetTechnologyName
- the name of the target technology that the connector implementation connects totargetTechnologyInterfaces
- the names of the interfaces in the target technology that the connector callstargetTechnologyVersions
- the versions of the target technology that the connector supportsrecognizedAdditionalProperties
- property name for additionalProperties in a linked Connection object.recognizedSecuredProperties
- property name for securedProperties in a linked Connection object.recognizedConfigurationProperties
- property name for configurationProperties in a linked Connection object.additionalProperties
- name value pairs for values that are not formally defined in the type systemsuppliedTypeName
- name of the subtype for the endpoint or null for standard typeextendedProperties
- any properties for a subtypeeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedeffectiveTime
- the time that the retrieved elements must be effective formethodName
- calling method- Returns:
- GUID for new connectorType
- Throws:
InvalidParameterException
- one of the parameters is null or invalid.PropertyServerException
- there is a problem adding the connectorType properties to the property server.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.
-
createConnectorTypeFromTemplate
public String createConnectorTypeFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String qualifiedName, String displayName, String description, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.- Parameters:
userId
- calling userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external sourcetemplateGUID
- unique identifier of the metadata element to copyqualifiedName
- unique name for the element - used in other configurationdisplayName
- short display name for the new elementdescription
- description of the new elementmethodName
- calling method- Returns:
- unique identifier of the new 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)
-
getConnectorTypeForAsset
public String getConnectorTypeForAsset(String userId, String supportedAssetTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Retrieves the connector type for the named asset type and if found, returns its unique identifier.- Parameters:
userId
- userId of user making requestsupportedAssetTypeName
- the type of asset that the connector implementation supportsforLineage
- 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 formethodName
- calling method- Returns:
- GUID for new connectorType
- Throws:
InvalidParameterException
- one of the parameters is null or invalid.PropertyServerException
- there is a problem adding the connectorType properties to the property server.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.
-
getConnectorTypeForConnection
public String getConnectorTypeForConnection(String userId, String externalSourceGUID, String externalSourceName, String anchorGUID, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String supportedDeployedImplementationType, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String, String> additionalProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedExceptionRetrieves the connector type for the qualified name and if found, returns its unique identifier. Otherwise, it creates a new connectorType and returns the unique identifier for it.- Parameters:
userId
- userId of user making requestexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external sourceanchorGUID
- unique identifier for the anchor of this connector type (or null if freestanding)qualifiedName
- unique name of the connectorTypedisplayName
- human memorable name for the connectorType - does not need to be uniquedescription
- (optional) description of the connectorType. Setting a description, particularly in a public connectorType makes the connectorType more valuable to other users and can act as an embryonic glossary termsupportedAssetTypeName
- the type of asset that the connector implementation supportssupportedDeployedImplementationType
- type of technologyexpectedDataFormat
- the format of the data that the connector supports - null for "any"connectorProviderClassName
- class name of the connector providerconnectorFrameworkName
- name of the connector framework that the connector implements - default Open Connector Framework (OCF)connectorInterfaceLanguage
- the language that the connector is implemented in - default JavaconnectorInterfaces
- list of interfaces that the connector supportstargetTechnologySource
- the organization that supplies the target technology that the connector implementation connects totargetTechnologyName
- the name of the target technology that the connector implementation connects totargetTechnologyInterfaces
- the names of the interfaces in the target technology that the connector callstargetTechnologyVersions
- the versions of the target technology that the connector supportsrecognizedAdditionalProperties
- property name for additionalProperties in a linked Connection object.recognizedSecuredProperties
- property name for securedProperties in a linked Connection object.recognizedConfigurationProperties
- property name for configurationProperties in a linked Connection object.additionalProperties
- name value pairs for values that are not formally defined in the type systemforLineage
- 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 formethodName
- calling method- Returns:
- GUID for new connectorType
- Throws:
InvalidParameterException
- one of the parameters is null or invalid.PropertyServerException
- there is a problem adding the connectorType properties to the property server.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.
-
updateConnectorType
public void updateConnectorType(String userId, String externalSourceGUID, String externalSourceName, String connectorTypeGUID, String connectorTypeGUIDParameterName, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String supportedDeployedImplementationType, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedAdditionalProperties, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, Map<String, String> additionalProperties, String suppliedTypeName, Map<String, throws InvalidParameterException, PropertyServerException, UserNotAuthorizedExceptionObject> extendedProperties, Date effectiveFrom, Date effectiveTo, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) Updates the properties of an existing connectorType.- Parameters:
userId
- userId of user making request.externalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external sourceconnectorTypeGUID
- unique identifier for the connectorTypeconnectorTypeGUIDParameterName
- parameter providing connectorTypeGUIDqualifiedName
- unique name of the connectorTypedisplayName
- human memorable name for the connectorType - does not need to be uniquedescription
- (optional) description of the connectorType. Setting a description, particularly in a public connectorType makes the connectorType more valuable to other users and can act as an embryonic glossary termsupportedAssetTypeName
- the type of asset that the connector implementation supportssupportedDeployedImplementationType
- the deployed implementation type that the connector implementation supportsexpectedDataFormat
- the format of the data that the connector supports - null for "any"connectorProviderClassName
- class name of the connector providerconnectorFrameworkName
- name of the connector framework that the connector implements - default Open Connector Framework (OCF)connectorInterfaceLanguage
- the language that the connector is implemented in - default JavaconnectorInterfaces
- list of interfaces that the connector supportstargetTechnologySource
- the organization that supplies the target technology that the connector implementation connects totargetTechnologyName
- the name of the target technology that the connector implementation connects totargetTechnologyInterfaces
- the names of the interfaces in the target technology that the connector callstargetTechnologyVersions
- the versions of the target technology that the connector supportsrecognizedAdditionalProperties
- property name for additionalProperties in a linked Connection object.recognizedSecuredProperties
- property name for securedProperties in a linked Connection object.recognizedConfigurationProperties
- property name for configurationProperties in a linked Connection object.additionalProperties
- name value pairs for values that are not formally defined in the type systemsuppliedTypeName
- name of the subtype for the endpoint or null for standard typeextendedProperties
- any properties for a subtypeeffectiveFrom
- the date when this element is active - null for active noweffectiveTo
- the date when this element becomes inactive - null for active until deletedisMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?forLineage
- 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 formethodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is null or invalid.PropertyServerException
- there is a problem adding the connectorType properties to the property server.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.
-
removeConnectorType
public void removeConnectorType(String userId, String externalSourceGUID, String externalSourceName, String guid, String guidParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element. This will delete all elements anchored to it.- Parameters:
userId
- calling userexternalSourceGUID
- guid of the software capability entity that represented the external source - null for localexternalSourceName
- name of the software capability entity that represented the external sourceguid
- unique identifier of the metadata element to removeguidParameterName
- parameter supplying the guidforLineage
- 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 formethodName
- 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)
-
findConnectorTypes
public List<B> findConnectorTypes(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 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
- name of parameter supplying the search stringstartFrom
- 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 formethodName
- 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)
-
getConnectorTypesByName
public List<B> getConnectorTypesByName(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 metadata elements with a matching qualified name, display name or connector provider class 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 formethodName
- 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)
-
getConnectorTypeByGUID
public B getConnectorTypeByGUID(String userId, String guid, String guidParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the metadata element with the supplied unique identifier.- Parameters:
userId
- calling userguid
- unique identifier of the requested metadata elementguidParameterName
- parameter name of guidforLineage
- 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 formethodName
- 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)
-