Class DataContractMapper
java.lang.Object
org.odpi.openmetadata.frameworks.integration.bitol.mapping.BitolMapperBase
org.odpi.openmetadata.frameworks.integration.bitol.mapping.DataContractMapper
DataContractMapper catalogues an Open Data Contract Standard (ODCS) document as an Agreement in open metadata.
- The document becomes an Agreement classified as a DataSharingAgreement (one element per version, qualifiedName DataContract::{id}::{version}) whose identifier is also recorded as an ExternalId shared by all versions.
- Each schema object becomes a DataStructure that is an item of the agreement; each property becomes a DataField member of the structure, with nested properties and array items as nested data fields. Primary key, classification and critical data element markers become the PrimaryKey, Confidentiality and Criticality classifications; relationships between properties become LinkedDataField relationships.
- Each data quality check becomes a DataQualityRule governance control that governs the structure or field.
- The SLA properties become a ServiceLevelObjective that governs the agreement; the description's limitations and usage become its restrictions and entitlements.
- Servers become Endpoints listed as resources of the agreement. A SecurityAccessControl governs the agreement and each access role becomes a SecurityRole associated with it, with the access type as the operation name.
- The tenant, tags, team, support channels and authoritative definitions are mapped as for data products (see BitolMapperBase).
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringAdditional property on the service level objective holding the SLA properties as JSON.Fields inherited from class org.odpi.openmetadata.frameworks.integration.bitol.mapping.BitolMapperBase
ADDITIONAL_PROPERTY_PREFIX, context, CONTEXT_JSON, CUSTOM_PROPERTIES_JSON, DEPRECATED, SEPARATOR, SYNONYMS_JSON -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncatalogueDataContract(DataContract dataContract, String source) Catalogue a data contract.Methods inherited from class org.odpi.openmetadata.frameworks.integration.bitol.mapping.BitolMapperBase
addCustomProperties, addDescriptionDetails, addSearchKeywords, canonical, fillFundamentals, findElementGUID, findElementsByDocumentId, getContactMethodType, getDocumentQualifiedName, getExternalIdQualifiedName, getLatestVersion, isRetired, linkAuthoritativeDefinitions, linkExternalId, linkSupportChannels, linkTeam, linkTenantOrganization, parseDate, putIfPresent, setContentStatus, toJSON, toStringValue
-
Field Details
-
SLA_PROPERTIES_JSON
Additional property on the service level objective holding the SLA properties as JSON.- See Also:
-
-
Constructor Details
-
DataContractMapper
Constructor.- Parameters:
context- connector context providing access to the open metadata clients
-
-
Method Details
-
catalogueDataContract
public BitolMappingResult catalogueDataContract(DataContract dataContract, String source) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Catalogue a data contract. Republishing the same version updates the existing elements; a new version creates new elements linked to the same ExternalId.- Parameters:
dataContract- document to cataloguesource- description of where the document came from (recorded on the ExternalId link)- Returns:
- result describing what was done and anything that could not be fully represented
- Throws:
InvalidParameterException- invalid parameterPropertyServerException- problem with the metadata storeUserNotAuthorizedException- security problem
-