Class SimpleCatalogArchiveHelper
java.lang.Object
org.odpi.openmetadata.samples.archiveutilities.SimpleCatalogArchiveHelper
- Direct Known Subclasses:
GovernanceArchiveHelper
SimpleCatalogArchiveHelper creates elements used when creating a simple catalog. This includes assets, their schemas and connections, design models.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected EnumElementDef
protected static final String
static final String
static final String
static final String
protected OpenMetadataArchiveBuilder
protected OMRSArchiveHelper
protected String
static final String
static final int
static final int
static final int
static final int
static final String
static final String
static final String
static final String
static final String
static final int
static final int
static final int
static final int
static final int
static final String
static final String
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final String
static final String
protected static final String
protected static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
protected static final String
protected OMRSArchiveGUIDMap
static final String
static final String
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
protected static final String
static final String
static final String
static final String
static final String
static final String
protected String
static final String
static final String
protected static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final int
static final int
static final int
static final int
static final int
static final String
static final String
static final String
protected static final String
protected String
-
Constructor Summary
ConstructorsConstructorDescriptionSimpleCatalogArchiveHelper
(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, String archiveRootName, String originatorName, Date creationDate, long versionNumber, String versionName) Typical constructor passes parameters used to build the open metadata archive's property header.SimpleCatalogArchiveHelper
(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, String archiveRootName, String originatorName, Date creationDate, long versionNumber, String versionName, InstanceProvenanceType instanceProvenanceType, String license) Typical constructor passes parameters used to build the open metadata archive's property header.SimpleCatalogArchiveHelper
(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, String originatorName, Date creationDate, long versionNumber, String versionName, String guidMapFileName) Constructor passes parameters used to build the open metadata archive's property header.SimpleCatalogArchiveHelper
(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, String originatorName, Date creationDate, long versionNumber, String versionName, InstanceProvenanceType instanceProvenanceType, String license, String guidMapFileName) Constructor passes parameters used to build the open metadata archive's property header. -
Method Summary
Modifier and TypeMethodDescriptionaddAPIOperation
(String apiSchemaTypeGUID, String qualifiedName, String displayName, String description, String path, String command, Map<String, String> additionalProperties) Create the schema type for an API operation.addAPIParameter
(String typeName, String schemaTypeName, String qualifiedName, String displayName, String description, String dataType, int length, int position, String parameterType, Map<String, String> additionalProperties) Create a schema attribute with a TypeEmbeddedAttribute classification.addAPIParameterList
(String apiOperationGUID, String relationshipTypeName, String qualifiedName, String displayName, String description, boolean required, Map<String, String> additionalProperties) Create a parameter list schema type for an API operation.addAsset
(String typeName, String qualifiedName, String name, String versionIdentifier, String description, List<String> governanceZones, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create an asset entity.addAsset
(String typeName, String qualifiedName, String name, String versionIdentifier, String description, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create an asset entity.addAsset
(String typeName, String qualifiedName, String name, String description, List<String> governanceZones, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create an asset entity.addAsset
(String typeName, String qualifiedName, String name, String description, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create an asset entity.addAsset
(String typeName, String qualifiedName, String name, String description, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create an asset entity.void
addAssetLocationRelationship
(String locationQName, String assetQName) Link a location to an asset.void
addAssetZoneMembershipClassification
(String assetGUID, List<String> zones) Add the asset zone membership classification to the requested asset.void
addAssignmentScopeRelationship
(String actorQName, String scopeQName, String assignmentType, String description) Link an actor (profile/person role) to a scope.void
addAttributeForSchemaType
(String schemaTypeGUID, String schemaAttributeGUID) Create the relationship between a SchemaType element and a child SchemaAttribute element using the AttributeForSchema relationship.addBusinessArea
(String qualifiedName, String identifier, String displayName, String description, Map<String, String> additionalProperties) Create a business area entity.addCategory
(String glossaryGUID, String qualifiedName, String displayName, String description, String subjectArea) Add a glossary category to the archive and connect it to glossary.addCategory
(String glossaryGUID, String qualifiedName, String displayName, String description, String subjectArea, Map<String, String> additionalProperties) Add a glossary category to the archive and connect it to glossary.void
addCategoryToCategory
(String parentCategoryGUID, String childCategoryGUID) Link two categories together as part of the parent child hierarchy.addCollection
(String suppliedTypeName, String classificationName, String qualifiedName, String displayName, String description, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a governance definition entity.addCommunity
(String suppliedTypeName, String qualifiedName, String name, String description, String mission, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Add a new community.void
addCommunityMembershipRelationship
(String communityQName, String membershipRoleQName, int membershipType) Link a community to a person role.void
addConceptBeadAttributeLink
(String conceptBeadGUID, String conceptBeadAttributeGUID, int position, int minCardinality, int maxCardinality, boolean uniqueValues, boolean orderedValues) Create the relationship between a concept bead link and the concept bead at one of its ends.void
addConceptBeadRelationshipEnd
(String conceptBeadLinkGUID, String conceptBeadGUID, String attributeName, int conceptModelDecoration, int position, int minCardinality, int maxCardinality, boolean uniqueValues, boolean orderedValues, boolean navigable) Create the relationship between a concept bead link and the concept bead at one of its ends.addConnection
(String qualifiedName, String displayName, String description, String userId, String clearPassword, String encryptedPassword, Map<String, String> securedProperties, Map<String, Object> configurationProperties, Map<String, String> additionalProperties, String connectorTypeGUID, String endpointGUID) Create a connection entity.void
addConnectionForAsset
(String assetGUID, String assetSummary, String connectionGUID) Create the relationship between an asset and its connection.addConnectorCategory
(String connectorTypeDirectoryGUID, String qualifiedName, String displayName, String description, String targetTechnologySource, String targetTechnologyName, Map<String, Boolean> recognizedSecuredProperties, Map<String, Boolean> recognizedConfigurationProperties, Map<String, Boolean> recognizedAdditionalProperties, Map<String, String> additionalProperties) Create a connector category entity.addConnectorType
(String connectorCategoryGUID, String connectorTypeGUID, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, List<String> recognizedAdditionalProperties, Map<String, String> additionalProperties) Create a connector type entity.protected String
addConnectorType
(String connectorCategoryGUID, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, List<String> recognizedAdditionalProperties, Map<String, String> additionalProperties) Create a connector type entity.addConnectorTypeDirectory
(String qualifiedName, String displayName, String description, Map<String, String> additionalProperties) Create a connector category entity.void
addContactDetails
(String profileGUID, String name, String contactType, int contactMethodType, String contactMethodService, String contactMethodValue) Add a contact method to a profile.addCyberLocation
(String qualifiedName, String identifier, String displayName, String description, String networkAddress, Map<String, String> additionalProperties) Add a location entity with the CyberLocation classification to the archive.void
addDataContentForDataSet
(String dataContentGUID, String dataSetGUID) Create the relationship between a data set and an asset that is providing all or part of its content.void
addDataContentForDataSet
(String dataContentGUID, String dataSetGUID, String queryId, String query) Create the relationship between a data set and an asset that is providing all or part of its content.addDesignModel
(String typeName, String classificationName, String qualifiedName, String displayName, String technicalName, String description, String versionNumber, String author, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a design model entity.addDesignModelElement
(String designModelGUID, String typeName, String qualifiedName, String displayName, String technicalName, String description, String versionNumber, String author, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create a design model element entity.void
addDesignModelGroupMembership
(String groupGUID, String memberGUID) Create the relationship between a design model group and one of its members.addEndpoint
(String qualifiedName, String displayName, String description, String networkAddress, String protocol, Map<String, String> additionalProperties) Create a endpoint entity.addExternalReference
(String typeName, String qualifiedName, String displayName, String referenceTitle, String referenceAbstract, String description, List<String> authors, int numberOfPages, String pageRange, String authorOrganization, String publicationSeries, String publicationSeriesVolume, String edition, String versionNumber, String referenceURL, String publisher, Date firstPublicationDate, Date publicationDate, String publicationCity, String publicationYear, List<String> publicationNumbers, String license, String copyright, String attribution, List<String> searchKeywords, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create an external reference entity.void
addExternalReferenceLink
(String referenceableGUID, String externalReferenceGUID, String referenceId, String description, String pages) Create the relationship between a referenceable and an external reference.addFixedLocation
(String qualifiedName, String identifier, String displayName, String description, String coordinates, String mapProjection, String postalAddress, String timeZone, Map<String, String> additionalProperties) Add a location with a FixedLocation classification.addGlossary
(String qualifiedName, String displayName, String description, String language, String usage, String externalLink, String scope) Create a glossary entity.addGlossary
(String qualifiedName, String displayName, String description, String language, String usage, String externalLink, String scope, Map<String, String> additionalProperties) Create a glossary entity.addGovernanceDefinition
(String suppliedTypeName, String qualifiedName, String title, String summary, String description, String scope, int domainIdentifier, String priority, List<String> implications, List<String> outcomes, List<String> results, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a governance definition entity.void
addGovernanceDefinitionDelegationRelationship
(String relationshipTypeName, String governanceDefinition1QName, String governanceDefinition2QName, String rationale) Link two governance definitions at the same level.void
addGovernanceDefinitionPeerRelationship
(String relationshipTypeName, String governanceDefinition1QName, String governanceDefinition2QName, String description) Link two governance definitions at the same level.void
addGovernanceDefinitionScopeRelationship
(String referenceableQName, String governanceDefinitionQName) Link a referenceable to a governance definition to define the scope there it applies.addGovernanceDomainDescription
(String governanceDomainSetGUID, String qualifiedName, int domainIdentifier, String displayName, String description, Map<String, String> additionalProperties) Create a governance domain description entity.addGovernanceRole
(String suppliedTypeName, String qualifiedName, int domainIdentifier, String identifier, String name, String description, String scope, boolean setHeadCount, int headCount, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Add a new person role.addGovernanceZone
(String qualifiedName, String zoneName, String displayName, String description, String criteria, String scope, int domainIdentifier, Map<String, String> additionalProperties) Create a governance zone entity.void
addGovernedByRelationship
(String referenceableQName, String governanceDefinitionQName) Link a referenceable to a governance definition to indicate that it is governed by the governance definition.void
addHasARelationship
(String conceptQName, String propertyQName) void
addIsATypeOfRelationship
(String specialTermQName, String generalizedTermQName) Add an is-a-type-of relationshipaddITProfileToAsset
(String assetGUID, String qualifiedName, String name, String description, Map<String, String> additionalProperties) Add a new IT profile.void
addLibraryCategoryReference
(String categoryGUID, String externalGlossaryLinkGUID, String identifier, String description, String steward, Date lastVerified) Link a category to an external glossary link with information on which category in the external glossary it corresponds to.void
addLibraryTermReference
(String termGUID, String externalGlossaryLinkGUID, String identifier, String description, String steward, Date lastVerified) Link a glossary term to an external glossary link with information on which term in the external glossary it corresponds to.addLocation
(String qualifiedName, String identifier, String displayName, String description, Map<String, String> additionalProperties) Add a location entity to the archive.void
addLocationHierarchy
(String broaderLocationGUID, String nestedLocationGUID) Create the relationship between a locations and one of the locations nested within it.addMediaReference
(String typeName, String qualifiedName, String displayName, String description, List<String> authors, String authorOrganization, String versionNumber, String referenceURL, String license, String copyright, String attribution, int mediaType, String mediaTypeOtherId, int defaultMediaUsage, String defaultMediaUsageOtherId, List<String> searchKeywords, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a media reference entity.void
addMediaReferenceLink
(String referenceableGUID, String mediaReferenceGUID, String mediaId, String description, int mediaUsage, String mediaUsageOtherId) Create the relationship between a referenceable and an external reference.void
addMemberToCollection
(String collectionGUID, String memberGUID, String membershipRationale) Add a member to a collection.void
addMobileAssetClassification
(String assetGUID) Add the MobileAsset classification to the requested asset.void
addMoreInformationLink
(String describedElementId, String describerElementId) Create a navigation link from one referenceable to another to show they provide more information.void
addNestedSchemaAttribute
(String parentSchemaAttributeGUID, String childSchemaAttributeGUID) Create the relationship between a SchemaAttribute element and a child SchemaAttribute element using the NestedSchemaAttribute relationship.void
addOrganizationalCapabilityRelationship
(String businessCapabilityQName, String teamQName, String scope) Add an OrganizationalCapability relationship.void
addPeerLocations
(String location1GUID, String location2GUID) Link two locations as peers using the AdjacentLocation relationship.void
addPeerRelationship
(String person1QName, String person2QName) Link a person profile to another person as a peer.addPerson
(String qualifiedName, String name, String pronouns, String description, String initials, String title, String givenNames, String surname, String fullName, String jobTitle, String employeeNumber, String employeeType, String preferredLanguage, boolean isPublic, Map<String, String> additionalProperties) Add a new person profile.addPersonRole
(String suppliedTypeName, String qualifiedName, String identifier, String name, String description, String scope, boolean setHeadCount, int headCount, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Add a new person role.void
addPersonRoleAppointmentRelationship
(String personQName, String personRoleQName, boolean isPublic) Link a person profile to a person role.addProcess
(String typeName, String qualifiedName, String name, String versionIdentifier, String description, String formula, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create a process entity.addProcess
(String typeName, String qualifiedName, String name, String description, String formula, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create a process entity.void
addProfileIdentity
(String profileGUID, String userIdentityGUID, String roleTypeName, String roleGUID, String description) Create the relationship between a profile and one of its userIds.void
addProfileLocationRelationship
(String profileQName, String locationQName, String associationType) Link a location to a profile.addProject
(String suppliedTypeName, String qualifiedName, String identifier, String name, String description, Date startDate, Date plannedEndDate, String projectStatus, boolean setCampaignClassification, boolean setTaskClassification, String projectTypeClassification, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Add a new project.void
addProjectDependencyRelationship
(String projectQName, String dependsOnProjectQName, String dependencySummary) Link a project to another project that it depends on.void
addProjectHierarchyRelationship
(String projectQName, String subprojectQName) Link a project to a subproject.void
addProjectManagementRelationship
(String projectQName, String projectManagerRoleQName) Link a project to a person role that represents the project manager(s).void
addProjectTeamRelationship
(String personQName, String personRoleQName, String teamRole) Link a project to a team.void
addReferenceDataClassification
(String assetGUID) Add the ReferenceData classification to the requested element.void
addReferenceValueAssignmentRelationship
(String referenceableQName, String validValueQName, int confidence, String steward, String stewardTypeName, String stewardPropertyName, String notes) Link a referenceable element to a valid value that is acting as a tag.void
addRelatedTermRelationship
(String conceptQName, String propertyQName) void
addResourceListRelationship
(String referenceableQName, String resourceQName, String resourceUse, boolean watchResource) Link a referenceable to another referenceable to indicate that the second referenceable is providing resources in support of the first.addSchemaAttribute
(String typeName, String schemaTypeName, String qualifiedName, String displayName, String description, String dataType, int length, int position, Map<String, String> additionalProperties) Create a schema attribute with a TypeEmbeddedAttribute classification.void
addSchemaTypeOption
(String schemaTypeChoiceGUID, String schemaTypeOptionGUID) Create the relationship between a SchemaTypeChoice element and a child element using the SchemaTypeOption relationship.addSecureLocation
(String qualifiedName, String identifier, String displayName, String description, String level, String securityDescription, Map<String, String> additionalProperties) Add a location with a SecureLocation classification.void
addSecurityTagsClassification
(String assetGUID, List<String> securityLabels, Map<String, Object> securityProperties, Map<String, List<String>> accessGroups) Add a SecurityTags classification to the requested element.addSoftwareCapability
(String typeName, String qualifiedName, String name, String description, String capabilityType, String capabilityVersion, String patchLevel, String source, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a software capability entity.void
addStakeHolderRelationship
(String referenceableQName, String actorQName) Link a referenceable to its stakeholders.void
addSubjectAreaClassification
(String referenceableGUID, String subjectAreaQualifiedName) Add the subject area classification to the requested element.addSubjectAreaDefinition
(String qualifiedName, String subjectAreaName, String displayName, String description, String scope, String usage, int domainIdentifier, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a subject area definition entity.void
addSubjectAreaHierarchy
(String broaderSubjectAreaGUID, String nestedSubjectAreaGUID) Create the relationship between a subject area and one of its nested subject areas.addTeam
(String suppliedTypeName, String qualifiedName, String name, String description, String teamType, String identifier, Map<String, String> additionalProperties) Add a new team profile.void
addTeamLeadershipRelationship
(String personRoleQName, String teamQName, String position) Link a person role as a team's leader.void
addTeamMembershipRelationship
(String personRoleQName, String teamQName, String position) Link a person role as a team's member.void
addTeamStructureRelationship
(String superTeamQName, String subTeamQName, boolean delegationEscalationAuthority) Link a person role as a team's member.addTerm
(String glossaryGUID, List<String> categoryIds, boolean categoriesAsNames, String qualifiedName, String displayName, String summary, String description, String examples, String abbreviation, String usage, boolean isSpineObject, boolean isSpineAttribute, boolean isContext, String contextDescription, String contextScope, Map<String, String> additionalProperties) Add a term and link it to the glossary and an arbitrary number of categories.addTerm
(String glossaryGUID, List<String> categoryGUIDs, String qualifiedName, String displayName, String description) Add a term and link it to the glossary and an arbitrary number of categories.void
addTermToCategory
(String categoryGUID, String termGUID) Link two categories together as part of the parent child hierarchy.void
addTermToCategory
(String categoryGUID, String termGUID, int status, String description) Link two categories together as part of the parent child hierarchy.void
addTermToContext
(String contextGUID, String termGUID, int status, String description) Link a term to a context referenceable to show that the term is valid in the context of the other.void
addTermToSynonym
(String synonymGUID, String termGUID, int status, String description, String expression, String steward, String source) Link two terms together to show that one is valid in the context of the other.addTopLevelSchemaType
(String assetGUID, String typeName, String qualifiedName, String displayName, String description, Map<String, String> additionalProperties) Create the top level schema type for an asset.addUserIdentity
(String qualifiedName, String userId, String distinguishedName, Map<String, String> additionalProperties) Add a user identity entity to the archive.addValidValue
(String typeName, String qualifiedName, String displayName, String description, String usage, String scope, String preferredValue, boolean isDeprecated, Map<String, String> additionalProperties) Add a valid value definition/set.void
addValidValueMembershipRelationship
(String setQName, String memberQName, boolean isDefaultValue) Link a valid value as a member of a valid value set.void
addValidValuesAssignmentRelationship
(String dataFieldQName, String validValueQName, boolean strictRequirement) Link an element that represents a data field (either directly or indirectly) to a valid value (typically a valid value set).void
addValidValuesImplementationRelationship
(String validValueQName, String assetQName, String symbolicName, String implementationValue, Map<String, String> additionalValues) Link a valid value definition to the asset where it is implemented.void
addValidValuesMappingRelationship
(String matchingValue1QName, String matchingValue2QName, String associationDescription, int confidence, String steward, String stewardTypeName, String stewardPropertyName, String notes) Add a mapping between two valid values.void
addZoneHierarchy
(String broaderGovernanceZoneGUID, String nestedGovernanceZoneGUID) Create the relationship between a governance zone and one of its nested governance zones.Return the guid of an element based on its qualified name.void
linkTermToReferenceable
(String termId, String referenceableId) Create a semantic assignment between a term and a Referenceable - for example a model element.Return the guid of an element based on its qualified name.void
Save the GUIDs so that the GUIDs of the elements inside the archive are consistent each time the archive runs.
-
Field Details
-
guidMapFileNamePostFix
- See Also:
-
NAMING_STANDARD_RULE_SET_TYPE_NAME
- See Also:
-
GOVERNANCE_DOMAIN_SET_CLASSIFICATION_NAME
- See Also:
-
GOVERNANCE_CLASSIFICATION_SET_CLASSIFICATION_NAME
- See Also:
-
GOVERNANCE_STATUS_SET_CLASSIFICATION_NAME
- See Also:
-
EXTERNAL_GLOSSARY_LINK_TYPE_NAME
- See Also:
-
RELATED_MEDIA_TYPE_NAME
- See Also:
-
MEDIA_USAGE_ICON
public static final int MEDIA_USAGE_ICON- See Also:
-
MEDIA_USAGE_THUMBNAIL
public static final int MEDIA_USAGE_THUMBNAIL- See Also:
-
MEDIA_USAGE_ILLUSTRATION
public static final int MEDIA_USAGE_ILLUSTRATION- See Also:
-
MEDIA_USAGE_USAGE_GUIDANCE
public static final int MEDIA_USAGE_USAGE_GUIDANCE- See Also:
-
MEDIA_USAGE_OTHER
public static final int MEDIA_USAGE_OTHER- See Also:
-
MEDIA_TYPE_IMAGE
public static final int MEDIA_TYPE_IMAGE- See Also:
-
MEDIA_TYPE_AUDIO
public static final int MEDIA_TYPE_AUDIO- See Also:
-
MEDIA_TYPE_DOCUMENT
public static final int MEDIA_TYPE_DOCUMENT- See Also:
-
MEDIA_TYPE_VIDEO
public static final int MEDIA_TYPE_VIDEO- See Also:
-
MEDIA_TYPE_OTHER
public static final int MEDIA_TYPE_OTHER- See Also:
-
GOVERNANCE_DRIVER_TYPE_NAME
- See Also:
-
GOVERNANCE_STRATEGY_TYPE_NAME
- See Also:
-
BUSINESS_IMPERATIVE_TYPE_NAME
- See Also:
-
REGULATION_TYPE_NAME
- See Also:
-
REGULATION_ARTICLE_TYPE_NAME
- See Also:
-
THREAT_TYPE_NAME
- See Also:
-
GOVERNANCE_POLICY_TYPE_NAME
- See Also:
-
GOVERNANCE_PRINCIPLE_TYPE_NAME
- See Also:
-
GOVERNANCE_OBLIGATION_TYPE_NAME
- See Also:
-
GOVERNANCE_APPROACH_TYPE_NAME
- See Also:
-
GOVERNANCE_CONTROL_TYPE_NAME
- See Also:
-
TECHNICAL_CONTROL_TYPE_NAME
- See Also:
-
SECURITY_GROUP_TYPE_NAME
- See Also:
-
GOVERNANCE_RULE_TYPE_NAME
- See Also:
-
NAMING_STANDARD_RULE_TYPE_NAME
- See Also:
-
GOVERNANCE_PROCESS_TYPE_NAME
- See Also:
-
ORGANIZATIONAL_CONTROL_TYPE_NAME
- See Also:
-
GOVERNANCE_RESPONSIBILITY_TYPE_NAME
- See Also:
-
GOVERNANCE_PROCEDURE_TYPE_NAME
- See Also:
-
LICENSE_TYPE_TYPE_NAME
- See Also:
-
CERTIFICATION_TYPE_TYPE_NAME
- See Also:
-
DATA_PROCESSING_PURPOSE_TYPE_NAME
- See Also:
-
GOVERNANCE_DRIVER_LINK_RELATIONSHIP_NAME
- See Also:
-
GOVERNANCE_RESPONSE_RELATIONSHIP_NAME
- See Also:
-
GOVERNANCE_POLICY_LINK_RELATIONSHIP_NAME
- See Also:
-
GOVERNANCE_IMPLEMENTATION_RELATIONSHIP_NAME
- See Also:
-
GOVERNANCE_CONTROL_LINK_RELATIONSHIP_NAME
- See Also:
-
GOVERNANCE_RULE_IMPLEMENTATION_RELATIONSHIP_NAME
- See Also:
-
GOVERNANCE_PROCESS_IMPLEMENTATION_RELATIONSHIP_NAME
- See Also:
-
GOVERNANCE_RESPONSIBILITY_ASSIGNMENT_RELATIONSHIP_NAME
- See Also:
-
BUSINESS_CAPABILITY_TYPE_UNCLASSIFIED
public static final int BUSINESS_CAPABILITY_TYPE_UNCLASSIFIED- See Also:
-
BUSINESS_CAPABILITY_TYPE_BUSINESS_SERVICE
public static final int BUSINESS_CAPABILITY_TYPE_BUSINESS_SERVICE- See Also:
-
BUSINESS_CAPABILITY_TYPE_BUSINESS_AREA
public static final int BUSINESS_CAPABILITY_TYPE_BUSINESS_AREA- See Also:
-
BUSINESS_CAPABILITY_TYPE_OTHER
public static final int BUSINESS_CAPABILITY_TYPE_OTHER- See Also:
-
TERM_RELATIONSHIP_STATUS_DRAFT
public static final int TERM_RELATIONSHIP_STATUS_DRAFT- See Also:
-
TERM_RELATIONSHIP_STATUS_ACTIVE
public static final int TERM_RELATIONSHIP_STATUS_ACTIVE- See Also:
-
TERM_RELATIONSHIP_STATUS_DEPRECATED
public static final int TERM_RELATIONSHIP_STATUS_DEPRECATED- See Also:
-
TERM_RELATIONSHIP_STATUS_OBSOLETE
public static final int TERM_RELATIONSHIP_STATUS_OBSOLETE- See Also:
-
TERM_RELATIONSHIP_STATUS_OTHER
public static final int TERM_RELATIONSHIP_STATUS_OTHER- See Also:
-
ORGANIZATION_TYPE_NAME
- See Also:
-
CONTACT_METHOD_TYPE_EMAIL
public static final int CONTACT_METHOD_TYPE_EMAIL- See Also:
-
CONTACT_METHOD_TYPE_PHONE
public static final int CONTACT_METHOD_TYPE_PHONE- See Also:
-
CONTACT_METHOD_TYPE_CHAT
public static final int CONTACT_METHOD_TYPE_CHAT- See Also:
-
CONTACT_METHOD_TYPE_PROFILE
public static final int CONTACT_METHOD_TYPE_PROFILE- See Also:
-
CONTACT_METHOD_TYPE_ACCOUNT
public static final int CONTACT_METHOD_TYPE_ACCOUNT- See Also:
-
CONTACT_METHOD_TYPE_OTHER
public static final int CONTACT_METHOD_TYPE_OTHER- See Also:
-
TEAM_LEADER_TYPE_NAME
- See Also:
-
TEAM_MEMBER_TYPE_NAME
- See Also:
-
PROJECT_MANAGER_TYPE_NAME
- See Also:
-
COMMUNITY_MEMBER_TYPE_NAME
- See Also:
-
NOTE_LOG_AUTHOR_TYPE_NAME
- See Also:
-
GOVERNANCE_ROLE_TYPE_NAME
- See Also:
-
GOVERNANCE_OFFICER_TYPE_NAME
- See Also:
-
GOVERNANCE_REPRESENTATIVE_TYPE_NAME
- See Also:
-
LOCATION_OWNER_TYPE_NAME
- See Also:
-
BUSINESS_OWNER_TYPE_NAME
- See Also:
-
SOLUTION_OWNER_TYPE_NAME
- See Also:
-
ASSET_OWNER_TYPE_NAME
- See Also:
-
SUBJECT_AREA_OWNER_TYPE_NAME
- See Also:
-
COMPONENT_OWNER_TYPE_NAME
- See Also:
-
DATA_ITEM_OWNER_TYPE_NAME
- See Also:
-
PROJECT_TYPE_NAME
- See Also:
-
CAMPAIGN_CLASSIFICATION_NAME
- See Also:
-
TASK_CLASSIFICATION_NAME
- See Also:
-
GLOSSARY_PROJECT_CLASSIFICATION_NAME
- See Also:
-
GOVERNANCE_PROJECT_CLASSIFICATION_NAME
- See Also:
-
COMMUNITY_TYPE_NAME
- See Also:
-
COMMUNITY_MEMBERSHIP_TYPE_CONTRIBUTOR
public static final int COMMUNITY_MEMBERSHIP_TYPE_CONTRIBUTOR- See Also:
-
COMMUNITY_MEMBERSHIP_TYPE_ADMINISTRATOR
public static final int COMMUNITY_MEMBERSHIP_TYPE_ADMINISTRATOR- See Also:
-
COMMUNITY_MEMBERSHIP_TYPE_LEADER
public static final int COMMUNITY_MEMBERSHIP_TYPE_LEADER- See Also:
-
COMMUNITY_MEMBERSHIP_TYPE_OBSERVER
public static final int COMMUNITY_MEMBERSHIP_TYPE_OBSERVER- See Also:
-
COMMUNITY_MEMBERSHIP_TYPE_OTHER
public static final int COMMUNITY_MEMBERSHIP_TYPE_OTHER- See Also:
-
CONCEPT_MODEL_DECORATION_NONE
public static final int CONCEPT_MODEL_DECORATION_NONE- See Also:
-
CONCEPT_MODEL_DECORATION_AGGREGATION
public static final int CONCEPT_MODEL_DECORATION_AGGREGATION- See Also:
-
CONCEPT_MODEL_DECORATION_COMPOSITION
public static final int CONCEPT_MODEL_DECORATION_COMPOSITION- See Also:
-
CONCEPT_MODEL_DECORATION_EXTENSION
public static final int CONCEPT_MODEL_DECORATION_EXTENSION- See Also:
-
CONCEPT_BEAD_COVERAGE_UNKNOWN
public static final int CONCEPT_BEAD_COVERAGE_UNKNOWN- See Also:
-
CONCEPT_BEAD_COVERAGE_UNIQUE_IDENTIFIER
public static final int CONCEPT_BEAD_COVERAGE_UNIQUE_IDENTIFIER- See Also:
-
CONCEPT_BEAD_COVERAGE_IDENTIFIER
public static final int CONCEPT_BEAD_COVERAGE_IDENTIFIER- See Also:
-
CONCEPT_BEAD_COVERAGE_CORE_DETAIL
public static final int CONCEPT_BEAD_COVERAGE_CORE_DETAIL- See Also:
-
CONCEPT_BEAD_COVERAGE_EXTENDED_DETAIL
public static final int CONCEPT_BEAD_COVERAGE_EXTENDED_DETAIL- See Also:
-
API_HEADER_TYPE_NAME
- See Also:
-
API_REQUEST_TYPE_NAME
- See Also:
-
API_RESPONSE_TYPE_NAME
- See Also:
-
VALID_VALUE_DEFINITION_TYPE_NAME
- See Also:
-
VALID_VALUE_SET_TYPE_NAME
- See Also:
-
QUALIFIED_NAME_PROPERTY
- See Also:
-
ADDITIONAL_PROPERTIES_PROPERTY
- See Also:
-
NAME_PROPERTY
- See Also:
-
VERSION_IDENTIFIER_PROPERTY
- See Also:
-
DISPLAY_NAME_PROPERTY
- See Also:
-
DESCRIPTION_PROPERTY
- See Also:
-
DOMAIN_IDENTIFIER_PROPERTY
- See Also:
-
archiveBuilder
-
archiveHelper
-
idToGUIDMap
-
archiveRootName
-
originatorName
-
versionName
-
activeStatus
-
-
Constructor Details
-
SimpleCatalogArchiveHelper
public SimpleCatalogArchiveHelper(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, String archiveRootName, String originatorName, Date creationDate, long versionNumber, String versionName) Typical constructor passes parameters used to build the open metadata archive's property header.- Parameters:
archiveBuilder
- builder where content is cachedarchiveGUID
- unique identifier for this open metadata archive.archiveName
- name of the open metadata archive metadata collection.archiveRootName
- non-spaced root name of the open metadata GUID map.originatorName
- name of the originator (person or organization) of the archive.creationDate
- data that this archive was created.versionNumber
- version number of the archive.versionName
- version name for the archive.
-
SimpleCatalogArchiveHelper
public SimpleCatalogArchiveHelper(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, String archiveRootName, String originatorName, Date creationDate, long versionNumber, String versionName, InstanceProvenanceType instanceProvenanceType, String license) Typical constructor passes parameters used to build the open metadata archive's property header.- Parameters:
archiveBuilder
- builder where content is cachedarchiveGUID
- unique identifier for this open metadata archive.archiveName
- name of the open metadata archive metadata collection.archiveRootName
- non-spaced root name of the open metadata GUID map.originatorName
- name of the originator (person or organization) of the archive.creationDate
- data that this archive was created.versionNumber
- version number of the archive.versionName
- version name for the archive.instanceProvenanceType
- type of archive.license
- license for the archive contents.
-
SimpleCatalogArchiveHelper
public SimpleCatalogArchiveHelper(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, String originatorName, Date creationDate, long versionNumber, String versionName, String guidMapFileName) Constructor passes parameters used to build the open metadata archive's property header. This version is used for multiple dependant archives, and they need to share the guid map.- Parameters:
archiveBuilder
- builder where content is cachedarchiveGUID
- unique identifier for this open metadata archive.archiveName
- name of the open metadata archive metadata collection.originatorName
- name of the originator (person or organization) of the archive.creationDate
- data that this archive was created.versionNumber
- version number of the archive.versionName
- version name for the archive.guidMapFileName
- name of the guid map file.
-
SimpleCatalogArchiveHelper
public SimpleCatalogArchiveHelper(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, String originatorName, Date creationDate, long versionNumber, String versionName, InstanceProvenanceType instanceProvenanceType, String license, String guidMapFileName) Constructor passes parameters used to build the open metadata archive's property header. This version is used for multiple dependant archives, and they need to share the guid map.- Parameters:
archiveBuilder
- builder where content is cachedarchiveGUID
- unique identifier for this open metadata archive.archiveName
- name of the open metadata archive metadata collection.originatorName
- name of the originator (person or organization) of the archive.creationDate
- data that this archive was created.versionNumber
- version number of the archive.versionName
- version name for the archive.instanceProvenanceType
- type of archive.license
- license for the archive contents.guidMapFileName
- name of the guid map file.
-
-
Method Details
-
getGUID
Return the guid of an element based on its qualified name. This is a lookup in the GUID map not the archive. This means if the qualified name is not known, a new GUID is generated.- Parameters:
qualifiedName
- qualified name ot look up- Returns:
- guid.
-
queryGUID
Return the guid of an element based on its qualified name. This is a query in the GUID map not the archive. This means if the qualified name is not known, null is returned.- Parameters:
qualifiedName
- qualified name ot look up- Returns:
- guid or null
-
saveGUIDs
public void saveGUIDs()Save the GUIDs so that the GUIDs of the elements inside the archive are consistent each time the archive runs. -
addExternalReference
public String addExternalReference(String typeName, String qualifiedName, String displayName, String referenceTitle, String referenceAbstract, String description, List<String> authors, int numberOfPages, String pageRange, String authorOrganization, String publicationSeries, String publicationSeriesVolume, String edition, String versionNumber, String referenceURL, String publisher, Date firstPublicationDate, Date publicationDate, String publicationCity, String publicationYear, List<String> publicationNumbers, String license, String copyright, String attribution, List<String> searchKeywords, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create an external reference entity. This typically describes a publication, webpage book or reference source of information that is from an external organization.- Parameters:
typeName
- name of element subtype to use - default is ExternalReferencequalifiedName
- unique name for the elementdisplayName
- display name for the elementreferenceTitle
- full title from the publicationreferenceAbstract
- full abstract from the publicationdescription
- description about the elementauthors
- authors of the elementnumberOfPages
- number of pages in the external sourcepageRange
- range of pages that is significantauthorOrganization
- organization that the information is frompublicationSeries
- publication series or journal that the external source is from.publicationSeriesVolume
- volume of the publication series where the external source is foundedition
- edition where the external source is fromversionNumber
- version number for the elementreferenceURL
- link to the external sourcepublisher
- publisher of the external sourcefirstPublicationDate
- date this material was first published (ie first version's publication date)publicationDate
- date that this version was publishedpublicationCity
- city that the publisher operates frompublicationYear
- year that this version was publishedpublicationNumbers
- list of ISBNs for this external sourcelicense
- name of the license associated with this external sourcecopyright
- copyright statement associated with this external sourceattribution
- attribution statement to use when consuming this external sourcesearchKeywords
- list of keywordsadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- unique identifier for new external reference (externalReferenceGUID)
-
addExternalReferenceLink
public void addExternalReferenceLink(String referenceableGUID, String externalReferenceGUID, String referenceId, String description, String pages) Create the relationship between a referenceable and an external reference.- Parameters:
referenceableGUID
- unique identifier of the element making the referenceexternalReferenceGUID
- unique identifier of the external referencereferenceId
- unique reference id for this referenceabledescription
- description of the relevance of the external referencepages
- relevant pages in the external reference
-
addMediaReference
public String addMediaReference(String typeName, String qualifiedName, String displayName, String description, List<String> authors, String authorOrganization, String versionNumber, String referenceURL, String license, String copyright, String attribution, int mediaType, String mediaTypeOtherId, int defaultMediaUsage, String defaultMediaUsageOtherId, List<String> searchKeywords, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a media reference entity. This typically describes an image, audio clip or video clip.- Parameters:
typeName
- name of element subtype to use - default is RelatedMediaqualifiedName
- unique name for the elementdisplayName
- display name for the elementdescription
- description about the elementauthors
- authors of the elementauthorOrganization
- organization that the information is fromversionNumber
- version number for the elementreferenceURL
- link to the external sourcelicense
- name of the license associated with this external sourcecopyright
- copyright statement associated with this external sourceattribution
- attribution statement to use when consuming this external sourcemediaType
- type of mediamediaTypeOtherId
- if media type is "other" add type heredefaultMediaUsage
- usage of media if not supplied on media reference link relationshipdefaultMediaUsageOtherId
- if default media usage is "other" add usage type heresearchKeywords
- list of keywordsadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- unique identifier for new media reference (mediaReferenceGUID)
-
addMediaReferenceLink
public void addMediaReferenceLink(String referenceableGUID, String mediaReferenceGUID, String mediaId, String description, int mediaUsage, String mediaUsageOtherId) Create the relationship between a referenceable and an external reference.- Parameters:
referenceableGUID
- unique identifier of the element making the referencemediaReferenceGUID
- unique identifier of the media referencemediaId
- unique reference id for this media elementdescription
- description of the relevance of the media referencemediaUsage
- type of usagemediaUsageOtherId
- other type of media usage (for example if using a valid value set).
-
addLocation
public String addLocation(String qualifiedName, String identifier, String displayName, String description, Map<String, String> additionalProperties) Add a location entity to the archive.- Parameters:
qualifiedName
- unique name of the locationidentifier
- code value or symbol used to identify the location - typically uniquedisplayName
- display name of the locationdescription
- description of the locationadditionalProperties
- any additional properties- Returns:
- unique identifier of the location
-
addFixedLocation
public String addFixedLocation(String qualifiedName, String identifier, String displayName, String description, String coordinates, String mapProjection, String postalAddress, String timeZone, Map<String, String> additionalProperties) Add a location with a FixedLocation classification.- Parameters:
qualifiedName
- unique name of the locationidentifier
- code value or symbol used to identify the location - typically uniquedisplayName
- display name of the locationdescription
- description of the locationcoordinates
- location coordinatesmapProjection
- type of location coordinatespostalAddress
- full postal addresstimeZone
- timezone of locationadditionalProperties
- any additional properties- Returns:
- unique identifier of the new location
-
addSecureLocation
public String addSecureLocation(String qualifiedName, String identifier, String displayName, String description, String level, String securityDescription, Map<String, String> additionalProperties) Add a location with a SecureLocation classification.- Parameters:
qualifiedName
- unique name of the locationidentifier
- code value or symbol used to identify the location - typically uniquedisplayName
- display name of the locationdescription
- description of the locationlevel
- level of securitysecurityDescription
- description of security provisionadditionalProperties
- additional properties for the location- Returns:
- unique identifier of the new location
-
addCyberLocation
public String addCyberLocation(String qualifiedName, String identifier, String displayName, String description, String networkAddress, Map<String, String> additionalProperties) Add a location entity with the CyberLocation classification to the archive.- Parameters:
qualifiedName
- unique name of the locationidentifier
- code value or symbol used to identify the location - typically uniquedisplayName
- display name of the locationdescription
- description of the locationnetworkAddress
- address of the cyber locationadditionalProperties
- any additional properties- Returns:
- unique identifier of the location
-
addMobileAssetClassification
Add the MobileAsset classification to the requested asset.- Parameters:
assetGUID
- unique identifier of the element to classify
-
addLocationHierarchy
Create the relationship between a locations and one of the locations nested within it.- Parameters:
broaderLocationGUID
- unique identifier of the broader locationnestedLocationGUID
- unique identifier of the nested location
-
addPeerLocations
Link two locations as peers using the AdjacentLocation relationship.- Parameters:
location1GUID
- unique identifier of the broader locationlocation2GUID
- unique identifier of the nested location
-
addAssetLocationRelationship
Link a location to an asset.- Parameters:
locationQName
- qualified name of the locationassetQName
- qualified name of the asset
-
addUserIdentity
public String addUserIdentity(String qualifiedName, String userId, String distinguishedName, Map<String, String> additionalProperties) Add a user identity entity to the archive.- Parameters:
qualifiedName
- unique name of the user identityuserId
- name of the user accountdistinguishedName
- LDAP name for the useradditionalProperties
- any additional properties- Returns:
- unique identifier of the user identity
-
addProfileLocationRelationship
public void addProfileLocationRelationship(String profileQName, String locationQName, String associationType) Link a location to a profile.- Parameters:
profileQName
- qualified name of the profilelocationQName
- qualified name of the locationassociationType
- identifier that describes the purpose of the association.
-
addProfileIdentity
public void addProfileIdentity(String profileGUID, String userIdentityGUID, String roleTypeName, String roleGUID, String description) Create the relationship between a profile and one of its userIds.- Parameters:
profileGUID
- unique identifier of the actor profileuserIdentityGUID
- unique identifier of the user identityroleTypeName
- type of role that uses this userIdroleGUID
- unique identifier of role that uses this userIddescription
- description of why role uses this userId
-
addContactDetails
public void addContactDetails(String profileGUID, String name, String contactType, int contactMethodType, String contactMethodService, String contactMethodValue) Add a contact method to a profile.- Parameters:
profileGUID
- unique identifier for a profilename
- name of the contact methodcontactType
- type of contact - eg home address, work mobile, emergency contact ...contactMethodType
- type of contact addresscontactMethodService
- service used in the contact methodcontactMethodValue
- name/account/url used to contact the individual
-
addPersonRole
public String addPersonRole(String suppliedTypeName, String qualifiedName, String identifier, String name, String description, String scope, boolean setHeadCount, int headCount, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Add a new person role.- Parameters:
suppliedTypeName
- type name to use for the person rolequalifiedName
- qualified name of roleidentifier
- unique codename
- display namedescription
- description (eg job description)scope
- scope of role's responsibilitiessetHeadCount
- should the headcount field be set?headCount
- number of people that may be appointed to the role (default = 1)additionalProperties
- are there any additional properties to addextendedProperties
- any additional properties associated with a subtype- Returns:
- unique identifier of the new profile
-
addGovernanceRole
public String addGovernanceRole(String suppliedTypeName, String qualifiedName, int domainIdentifier, String identifier, String name, String description, String scope, boolean setHeadCount, int headCount, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Add a new person role.- Parameters:
suppliedTypeName
- type name to use for the person rolequalifiedName
- qualified name of roledomainIdentifier
- identifier of governance domainidentifier
- unique codename
- display namedescription
- description (eg job description)scope
- scope of role's responsibilitiessetHeadCount
- should the headcount field be set?headCount
- number of people that may be appointed to the role (default = 1)additionalProperties
- are there any additional properties to addextendedProperties
- any additional properties associated with a subtype- Returns:
- unique identifier of the new profile
-
addPersonRoleAppointmentRelationship
public void addPersonRoleAppointmentRelationship(String personQName, String personRoleQName, boolean isPublic) Link a person profile to a person role.- Parameters:
personQName
- qualified name of the person profilepersonRoleQName
- qualified name of the person roleisPublic
- is this appointment public?
-
addPeerRelationship
Link a person profile to another person as a peer.- Parameters:
person1QName
- qualified name of the first person profileperson2QName
- qualified name of the second person profile
-
addPerson
public String addPerson(String qualifiedName, String name, String pronouns, String description, String initials, String title, String givenNames, String surname, String fullName, String jobTitle, String employeeNumber, String employeeType, String preferredLanguage, boolean isPublic, Map<String, String> additionalProperties) Add a new person profile.- Parameters:
qualifiedName
- qualified name of profilename
- display name (preferred name of individual)pronouns
- preferred pronounsdescription
- description (eg job description)title
- courtesy titleinitials
- given names initialsgivenNames
- list of given namessurname
- family namefullName
- full legal namejobTitle
- job titleemployeeNumber
- unique employee contract numberemployeeType
- type of employeepreferredLanguage
- preferred language to communicate withisPublic
- is this profile publicadditionalProperties
- are there any additional properties to add- Returns:
- unique identifier of the new profile
-
addTeam
public String addTeam(String suppliedTypeName, String qualifiedName, String name, String description, String teamType, String identifier, Map<String, String> additionalProperties) Add a new team profile.- Parameters:
suppliedTypeName
- type name for the teamqualifiedName
- qualified name of profilename
- display name (preferred name of individual)description
- description (eg job description)teamType
- type of teamidentifier
- code value identifier for the teamadditionalProperties
- are there any additional properties to add- Returns:
- unique identifier of the new profile
-
addTeamLeadershipRelationship
public void addTeamLeadershipRelationship(String personRoleQName, String teamQName, String position) Link a person role as a team's leader.- Parameters:
personRoleQName
- qualified name of the person roleteamQName
- qualified name of the team profileposition
- position of the role
-
addTeamMembershipRelationship
public void addTeamMembershipRelationship(String personRoleQName, String teamQName, String position) Link a person role as a team's member.- Parameters:
personRoleQName
- qualified name of the person roleteamQName
- qualified name of the team profileposition
- position of the role
-
addTeamStructureRelationship
public void addTeamStructureRelationship(String superTeamQName, String subTeamQName, boolean delegationEscalationAuthority) Link a person role as a team's member.- Parameters:
superTeamQName
- qualified name of the super team profilesubTeamQName
- qualified name of the subteam profiledelegationEscalationAuthority
- delegationEscalationAuthority of the role
-
addITProfileToAsset
public String addITProfileToAsset(String assetGUID, String qualifiedName, String name, String description, Map<String, String> additionalProperties) Add a new IT profile.- Parameters:
assetGUID
- unique identifier of asset to connect the profile to.qualifiedName
- qualified name of profilename
- display name (preferred name of individual)description
- description (eg job description)additionalProperties
- are there any additional properties to add- Returns:
- unique identifier of the new profile
-
addAssignmentScopeRelationship
public void addAssignmentScopeRelationship(String actorQName, String scopeQName, String assignmentType, String description) Link an actor (profile/person role) to a scope.- Parameters:
actorQName
- qualified name of the actorscopeQName
- qualified name of the scopeassignmentType
- type of the assignmentdescription
- description of the assignment
-
addProject
public String addProject(String suppliedTypeName, String qualifiedName, String identifier, String name, String description, Date startDate, Date plannedEndDate, String projectStatus, boolean setCampaignClassification, boolean setTaskClassification, String projectTypeClassification, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Add a new project.- Parameters:
suppliedTypeName
- subtype informationqualifiedName
- qualified name of projectidentifier
- unique identifier of project - typically allocated externallyname
- display namedescription
- descriptionstartDate
- date the project startedplannedEndDate
- date the project is expected to endprojectStatus
- status of the projectsetCampaignClassification
- should the Campaign classification be set?setTaskClassification
- should the Task classification be set?projectTypeClassification
- add special classification that defines the type of project - eg GlossaryProject or GovernanceProjectadditionalProperties
- are there any additional properties to addextendedProperties
- any additional properties associated with a subtype- Returns:
- unique identifier of the new profile
-
addProjectHierarchyRelationship
Link a project to a subproject.- Parameters:
projectQName
- qualified name of the parent projectsubprojectQName
- qualified name of the subproject
-
addStakeHolderRelationship
Link a referenceable to its stakeholders.- Parameters:
referenceableQName
- qualified name of the parent projectactorQName
- qualified name of the subproject
-
addProjectDependencyRelationship
public void addProjectDependencyRelationship(String projectQName, String dependsOnProjectQName, String dependencySummary) Link a project to another project that it depends on.- Parameters:
projectQName
- qualified name of the projectdependsOnProjectQName
- qualified name of the project that it depends ondependencySummary
- description of what makes them dependent
-
addProjectTeamRelationship
Link a project to a team. A project may have multiple teams.- Parameters:
personQName
- qualified name of the person profilepersonRoleQName
- qualified name of the person roleteamRole
- role of this team in the project
-
addProjectManagementRelationship
Link a project to a person role that represents the project manager(s).- Parameters:
projectQName
- qualified name of the projectprojectManagerRoleQName
- qualified name of the person role
-
addCommunity
public String addCommunity(String suppliedTypeName, String qualifiedName, String name, String description, String mission, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Add a new community.- Parameters:
suppliedTypeName
- subtype informationqualifiedName
- qualified name of communityname
- display namedescription
- descriptionmission
- why is the community formed?additionalProperties
- are there any additional properties to addextendedProperties
- any additional properties associated with a subtype- Returns:
- unique identifier of the new profile
-
addCommunityMembershipRelationship
public void addCommunityMembershipRelationship(String communityQName, String membershipRoleQName, int membershipType) Link a community to a person role.- Parameters:
communityQName
- qualified name of the communitymembershipRoleQName
- qualified name of the membership rolemembershipType
- ordinal of enum
-
addCollection
public String addCollection(String suppliedTypeName, String classificationName, String qualifiedName, String displayName, String description, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a governance definition entity.- Parameters:
suppliedTypeName
- type of collectionclassificationName
- name of classification to attachqualifiedName
- unique name for the collection entitydisplayName
- display name for the collectiondescription
- description about the collectionadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- unique identifier for subject area (collectionGUID)
-
addMemberToCollection
public void addMemberToCollection(String collectionGUID, String memberGUID, String membershipRationale) Add a member to a collection.- Parameters:
collectionGUID
- unique identifier of the collectionmemberGUID
- unique identifier of the membermembershipRationale
- why is this member in this collection
-
addGovernanceDomainDescription
public String addGovernanceDomainDescription(String governanceDomainSetGUID, String qualifiedName, int domainIdentifier, String displayName, String description, Map<String, String> additionalProperties) Create a governance domain description entity.- Parameters:
qualifiedName
- unique name for the governance domain entitydomainIdentifier
- unique identifier of the governance domaindisplayName
- display name for the governance domaindescription
- description about the governance domainadditionalProperties
- any other propertiesgovernanceDomainSetGUID
- unique identifier of the collection for the domain definitions- Returns:
- unique identifier for the governance domain (governanceDomainGUID)
-
addGovernanceDefinition
public String addGovernanceDefinition(String suppliedTypeName, String qualifiedName, String title, String summary, String description, String scope, int domainIdentifier, String priority, List<String> implications, List<String> outcomes, List<String> results, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a governance definition entity.- Parameters:
suppliedTypeName
- type of governance definition to addqualifiedName
- unique name for the governance definition entitytitle
- title for the governance definitionsummary
- short description for the governance definitiondescription
- description about the governance definitionscope
- scope where the governance definition is usedpriority
- how important is the governance definitiondomainIdentifier
- unique identifier of the governance domainimplications
- expected impact of adopting this definitionoutcomes
- expected outcomes from adopting this definitionresults
- results from adopting this definitionadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- unique identifier for governance definition (governanceDefinitionGUID)
-
addGovernanceDefinitionScopeRelationship
public void addGovernanceDefinitionScopeRelationship(String referenceableQName, String governanceDefinitionQName) Link a referenceable to a governance definition to define the scope there it applies.- Parameters:
referenceableQName
- qualified name of the referenceablegovernanceDefinitionQName
- qualified name of the governance definition
-
addGovernedByRelationship
Link a referenceable to a governance definition to indicate that it is governed by the governance definition.- Parameters:
referenceableQName
- qualified name of the referenceablegovernanceDefinitionQName
- qualified name of the governance definition
-
addResourceListRelationship
public void addResourceListRelationship(String referenceableQName, String resourceQName, String resourceUse, boolean watchResource) Link a referenceable to another referenceable to indicate that the second referenceable is providing resources in support of the first.- Parameters:
referenceableQName
- qualified name of the referenceableresourceQName
- qualified name of the second referenceableresourceUse
- string descriptionwatchResource
- should the resource be watched (boolean)
-
addGovernanceDefinitionPeerRelationship
public void addGovernanceDefinitionPeerRelationship(String relationshipTypeName, String governanceDefinition1QName, String governanceDefinition2QName, String description) Link two governance definitions at the same level.- Parameters:
relationshipTypeName
- type of relationshipgovernanceDefinition1QName
- qualified name of the referenceablegovernanceDefinition2QName
- qualified name of the governance definitiondescription
- description of the peer relationship
-
addGovernanceDefinitionDelegationRelationship
public void addGovernanceDefinitionDelegationRelationship(String relationshipTypeName, String governanceDefinition1QName, String governanceDefinition2QName, String rationale) Link two governance definitions at the same level.- Parameters:
relationshipTypeName
- type of relationshipgovernanceDefinition1QName
- qualified name of the referenceablegovernanceDefinition2QName
- qualified name of the governance definitionrationale
- description of the delegation relationship
-
addGovernanceZone
public String addGovernanceZone(String qualifiedName, String zoneName, String displayName, String description, String criteria, String scope, int domainIdentifier, Map<String, String> additionalProperties) Create a governance zone entity.- Parameters:
qualifiedName
- unique name for the zone entityzoneName
- unique name for the zonedisplayName
- display name for the zonedescription
- description about the zonescope
- scope where the zone is usedcriteria
- what is the common characteristic of assets in this zone?domainIdentifier
- unique identifier of the governance domain (0 means all/any)additionalProperties
- any other properties- Returns:
- unique identifier for governance zone (governanceZoneGUID)
-
addZoneHierarchy
Create the relationship between a governance zone and one of its nested governance zones.- Parameters:
broaderGovernanceZoneGUID
- unique identifier of the broader zonenestedGovernanceZoneGUID
- unique identifier of the nested (narrower) zone
-
addAssetZoneMembershipClassification
Add the asset zone membership classification to the requested asset.- Parameters:
assetGUID
- unique identifier of the asset to classifyzones
- list of zones that the asset is a member of.
-
addSubjectAreaDefinition
public String addSubjectAreaDefinition(String qualifiedName, String subjectAreaName, String displayName, String description, String scope, String usage, int domainIdentifier, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a subject area definition entity.- Parameters:
qualifiedName
- unique name for the subject area entitysubjectAreaName
- unique name for the subject areadisplayName
- display name for the subject areadescription
- description about the subject areascope
- scope where the subject area is usedusage
- how is the subject area useddomainIdentifier
- unique identifier of the governance domainadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- unique identifier for subject area (subjectAreaGUID)
-
addSubjectAreaHierarchy
Create the relationship between a subject area and one of its nested subject areas.- Parameters:
broaderSubjectAreaGUID
- unique identifier of the broader subject areanestedSubjectAreaGUID
- unique identifier of the nested (narrower) subject area
-
addSubjectAreaClassification
Add the subject area classification to the requested element.- Parameters:
referenceableGUID
- unique identifier of the element to classifysubjectAreaQualifiedName
- name of the subject area. The suggestion is that the name used is the qualified name.
-
addBusinessArea
public String addBusinessArea(String qualifiedName, String identifier, String displayName, String description, Map<String, String> additionalProperties) Create a business area entity.- Parameters:
qualifiedName
- unique name for the business area entityidentifier
- unique name for the business areadisplayName
- display name for the business areadescription
- description about the business areaadditionalProperties
- any other properties- Returns:
- unique identifier for business area (businessAreaGUID)
-
addOrganizationalCapabilityRelationship
public void addOrganizationalCapabilityRelationship(String businessCapabilityQName, String teamQName, String scope) Add an OrganizationalCapability relationship.- Parameters:
businessCapabilityQName
- qualified name of the specialized termteamQName
- qualified name of the generalized termscope
- scope of the team's ability to support the business capability
-
addDesignModel
public String addDesignModel(String typeName, String classificationName, String qualifiedName, String displayName, String technicalName, String description, String versionNumber, String author, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a design model entity.- Parameters:
typeName
- name of element subtype to use - default is DesignModelclassificationName
- name of classification the identifies the type of design modelqualifiedName
- unique name for the elementdisplayName
- display name for the elementtechnicalName
- technical name for the elementdescription
- description about the elementversionNumber
- version number for the elementauthor
- author of the elementadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- unique identifier for new design model (designModelGUID)
-
addDesignModelElement
public String addDesignModelElement(String designModelGUID, String typeName, String qualifiedName, String displayName, String technicalName, String description, String versionNumber, String author, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create a design model element entity. This may be a group or an element in the model.- Parameters:
designModelGUID
- unique identifier of model that owns this elementtypeName
- name of element subtype to use - default is DesignModelElementqualifiedName
- unique name for the elementdisplayName
- display name for the elementtechnicalName
- technical name for the elementdescription
- description about the elementversionNumber
- version number for the elementauthor
- author of the elementadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtypeclassifications
- list of classifications (if any)- Returns:
- unique identifier for the new model element
-
addDesignModelGroupMembership
Create the relationship between a design model group and one of its members.- Parameters:
groupGUID
- unique identifier of the design model groupmemberGUID
- unique identifier of the member
-
addConceptBeadRelationshipEnd
public void addConceptBeadRelationshipEnd(String conceptBeadLinkGUID, String conceptBeadGUID, String attributeName, int conceptModelDecoration, int position, int minCardinality, int maxCardinality, boolean uniqueValues, boolean orderedValues, boolean navigable) Create the relationship between a concept bead link and the concept bead at one of its ends.- Parameters:
conceptBeadLinkGUID
- unique identifier of the concept bead link entityconceptBeadGUID
- unique identifier of the concept beadattributeName
- name of the attribute for this endconceptModelDecoration
- what type of relationship endposition
- in the attributes for the beadminCardinality
- minimum number of the relationshipsmaxCardinality
- maximum number of the relationshipsuniqueValues
- are the relationship values uniqueorderedValues
- are the relationship values in any order (using position)navigable
- is it possible to navigate to the concept bead
-
addConceptBeadAttributeLink
public void addConceptBeadAttributeLink(String conceptBeadGUID, String conceptBeadAttributeGUID, int position, int minCardinality, int maxCardinality, boolean uniqueValues, boolean orderedValues) Create the relationship between a concept bead link and the concept bead at one of its ends.- Parameters:
conceptBeadGUID
- unique identifier of the concept bead entityconceptBeadAttributeGUID
- unique identifier of the concept bead attribute entityposition
- in the attributes for the beadminCardinality
- minimum number of the relationshipsmaxCardinality
- maximum number of the relationshipsuniqueValues
- are the relationship values uniqueorderedValues
- are the relationship values in any order (using position)
-
addAsset
public String addAsset(String typeName, String qualifiedName, String name, String description, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create an asset entity.- Parameters:
typeName
- name of asset subtype to use - default is AssetqualifiedName
- unique name for the assetname
- display name for the assetdescription
- description about the assetadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtypeclassifications
- list of classifications (if any)- Returns:
- id for the asset
-
addAsset
public String addAsset(String typeName, String qualifiedName, String name, String versionIdentifier, String description, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create an asset entity.- Parameters:
typeName
- name of asset subtype to use - default is AssetqualifiedName
- unique name for the assetname
- display name for the assetversionIdentifier
- version for the assetdescription
- description about the assetadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtypeclassifications
- list of classifications (if any)- Returns:
- id for the asset
-
addAsset
public String addAsset(String typeName, String qualifiedName, String name, String description, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create an asset entity.- Parameters:
typeName
- name of asset subtype to use - default is AssetqualifiedName
- unique name for the assetname
- display name for the assetdescription
- description about the assetadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- id for the asset
-
addAsset
public String addAsset(String typeName, String qualifiedName, String name, String description, List<String> governanceZones, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create an asset entity.- Parameters:
typeName
- name of asset subtype to use - default is AssetqualifiedName
- unique name for the assetname
- display name for the assetdescription
- description about the assetgovernanceZones
- list of zones to add to the assetadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- id for the asset
-
addAsset
public String addAsset(String typeName, String qualifiedName, String name, String versionIdentifier, String description, List<String> governanceZones, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create an asset entity.- Parameters:
typeName
- name of asset subtype to use - default is AssetqualifiedName
- unique name for the assetname
- display name for the assetversionIdentifier
- version of the assetdescription
- description about the assetgovernanceZones
- list of zones to add to the assetadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtype- Returns:
- id for the asset
-
addProcess
public String addProcess(String typeName, String qualifiedName, String name, String description, String formula, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create a process entity.- Parameters:
typeName
- name of asset subtype to use - default is AssetqualifiedName
- unique name for the assetname
- display name for the assetdescription
- description about the assetformula
- description of the logic that this process performsadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtypeclassifications
- list of classifications (if any)- Returns:
- id for the asset
-
addProcess
public String addProcess(String typeName, String qualifiedName, String name, String versionIdentifier, String description, String formula, Map<String, String> additionalProperties, Map<String, Object> extendedProperties, List<Classification> classifications) Create a process entity.- Parameters:
typeName
- name of asset subtype to use - default is AssetqualifiedName
- unique name for the assetname
- display name for the assetversionIdentifier
- version of the assetdescription
- description about the assetformula
- description of the logic that this process performsadditionalProperties
- any other propertiesextendedProperties
- additional properties defined in the subtypeclassifications
- list of classifications (if any)- Returns:
- id for the asset
-
addSoftwareCapability
public String addSoftwareCapability(String typeName, String qualifiedName, String name, String description, String capabilityType, String capabilityVersion, String patchLevel, String source, Map<String, String> additionalProperties, Map<String, Object> extendedProperties) Create a software capability entity.- Parameters:
typeName
- name of software capability subtype to use - default is SoftwareCapabilityqualifiedName
- unique name for the capabilityname
- display name for the capabilitydescription
- description about the capabilitycapabilityType
- typecapabilityVersion
- versionpatchLevel
- patch levelsource
- sourceadditionalProperties
- any other propertiesextendedProperties
- properties for subtype- Returns:
- id for the capability
-
addConnectionForAsset
Create the relationship between an asset and its connection.- Parameters:
assetGUID
- unique identifier of the assetassetSummary
- summary of the asset from the connection perspectiveconnectionGUID
- unique identifier of the connection to its content
-
addDataContentForDataSet
Create the relationship between a data set and an asset that is providing all or part of its content.- Parameters:
dataContentGUID
- unique identifier of the data storedataSetGUID
- unique identifier of the consuming data set
-
addDataContentForDataSet
public void addDataContentForDataSet(String dataContentGUID, String dataSetGUID, String queryId, String query) Create the relationship between a data set and an asset that is providing all or part of its content.- Parameters:
dataContentGUID
- unique identifier of the data storedataSetGUID
- unique identifier of the consuming data setqueryId
- identifier of the query used to combine results in a broader formula of the data setquery
- query to issue against this data content
-
addTopLevelSchemaType
public String addTopLevelSchemaType(String assetGUID, String typeName, String qualifiedName, String displayName, String description, Map<String, String> additionalProperties) Create the top level schema type for an asset.- Parameters:
assetGUID
- unique identifier of assettypeName
- name of asset subtype to use - default is SchemaTypequalifiedName
- unique name for the schema typedisplayName
- display name for the schema typedescription
- description about the schema typeadditionalProperties
- any other properties- Returns:
- id for the schemaType
-
addAPIOperation
public String addAPIOperation(String apiSchemaTypeGUID, String qualifiedName, String displayName, String description, String path, String command, Map<String, String> additionalProperties) Create the schema type for an API operation.- Parameters:
apiSchemaTypeGUID
- unique identifier of top level schemaTypequalifiedName
- unique name for the schema typedisplayName
- display name for the schema typedescription
- description about the schema typepath
- the path name for the operationcommand
- the command to issue eg GET, POSTadditionalProperties
- any other properties- Returns:
- id for the schemaType
-
addAPIParameterList
public String addAPIParameterList(String apiOperationGUID, String relationshipTypeName, String qualifiedName, String displayName, String description, boolean required, Map<String, String> additionalProperties) Create a parameter list schema type for an API operation.- Parameters:
apiOperationGUID
- unique identifier of top level schemaTyperelationshipTypeName
- name of relationship type - default is APIRequestqualifiedName
- unique name for the schema typedisplayName
- display name for the schema typedescription
- description about the schema typerequired
- is this parameter list requiredadditionalProperties
- any other properties- Returns:
- id for the schemaType
-
addAPIParameter
public String addAPIParameter(String typeName, String schemaTypeName, String qualifiedName, String displayName, String description, String dataType, int length, int position, String parameterType, Map<String, String> additionalProperties) Create a schema attribute with a TypeEmbeddedAttribute classification.- Parameters:
typeName
- name of schema attribute subtype to use - default is SchemaAttributeschemaTypeName
- name of schema type subtype to use - default is PrimitiveSchemaTypequalifiedName
- unique name for the schema attributedisplayName
- display name for the schema attributedescription
- description about the schema attributedataType
- data type for the schema attributelength
- length of the storage used by the schema attributeposition
- position in the schema at this levelparameterType
- type of parameteradditionalProperties
- any other properties.- Returns:
- id for the schema attribute
-
addSchemaTypeOption
Create the relationship between a SchemaTypeChoice element and a child element using the SchemaTypeOption relationship.- Parameters:
schemaTypeChoiceGUID
- unique identifier of the parent elementschemaTypeOptionGUID
- unique identifier of the child element
-
addAttributeForSchemaType
Create the relationship between a SchemaType element and a child SchemaAttribute element using the AttributeForSchema relationship.- Parameters:
schemaTypeGUID
- unique identifier of the parent elementschemaAttributeGUID
- unique identifier of the child element
-
addNestedSchemaAttribute
public void addNestedSchemaAttribute(String parentSchemaAttributeGUID, String childSchemaAttributeGUID) Create the relationship between a SchemaAttribute element and a child SchemaAttribute element using the NestedSchemaAttribute relationship.- Parameters:
parentSchemaAttributeGUID
- unique identifier of the parent elementchildSchemaAttributeGUID
- unique identifier of the child element
-
addSchemaAttribute
public String addSchemaAttribute(String typeName, String schemaTypeName, String qualifiedName, String displayName, String description, String dataType, int length, int position, Map<String, String> additionalProperties) Create a schema attribute with a TypeEmbeddedAttribute classification.- Parameters:
typeName
- name of schema attribute subtype to use - default is SchemaAttributeschemaTypeName
- name of schema type subtype to use - default is PrimitiveSchemaTypequalifiedName
- unique name for the schema attributedisplayName
- display name for the schema attributedescription
- description about the schema attributedataType
- data type for the schema attributelength
- length of the storage used by the schema attributeposition
- position in the schema at this leveladditionalProperties
- any other properties.- Returns:
- id for the schema attribute
-
addConnection
public String addConnection(String qualifiedName, String displayName, String description, String userId, String clearPassword, String encryptedPassword, Map<String, String> securedProperties, Map<String, Object> configurationProperties, Map<String, String> additionalProperties, String connectorTypeGUID, String endpointGUID) Create a connection entity.- Parameters:
qualifiedName
- unique name for the connectiondisplayName
- display name for the connectiondescription
- description about the connectionuserId
- userId that the connector should use to connect to the platform that hosts the asset.clearPassword
- possible password for the connectorencryptedPassword
- possible password for the connectorsecuredProperties
- properties hidden from the clientconfigurationProperties
- properties used to configure the connectoradditionalProperties
- any other properties.connectorTypeGUID
- unique identifier for the connector typeendpointGUID
- unique identifier for the endpoint of the asset- Returns:
- id for the connection
-
addConnectorType
public String addConnectorType(String connectorCategoryGUID, String connectorTypeGUID, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, List<String> recognizedAdditionalProperties, Map<String, String> additionalProperties) Create a connector type entity.- Parameters:
connectorCategoryGUID
- unique identifier of connector category - or null is not categorizedconnectorTypeGUID
- fixed unique identifier for connector type - comes from the Connector ProviderqualifiedName
- unique name for the connector typedisplayName
- display name for the connector typedescription
- description about the connector typesupportedAssetTypeName
- type of asset supported by this connectorexpectedDataFormat
- format of the data stored in the resourceconnectorProviderClassName
- code for this type of connectorconnectorFrameworkName
- name of the framework that the connector implements - default "Open Connector Framework (OCF)"connectorInterfaceLanguage
- programming language of the connector's interfaceconnectorInterfaces
- the interfaces that the connector implementstargetTechnologySource
- organization implementing the target technologytargetTechnologyName
- name of the target technologytargetTechnologyInterfaces
- called interfaces the target technologytargetTechnologyVersions
- supported versions of the target technologyrecognizedSecuredProperties
- names of supported properties hidden from the client - for connection object.recognizedConfigurationProperties
- names of supported properties used to configure the connector - for connection object.recognizedAdditionalProperties
- names of any other properties for connection object.additionalProperties
- any other properties.- Returns:
- id for the connector type
-
addConnectorType
protected String addConnectorType(String connectorCategoryGUID, String qualifiedName, String displayName, String description, String supportedAssetTypeName, String expectedDataFormat, String connectorProviderClassName, String connectorFrameworkName, String connectorInterfaceLanguage, List<String> connectorInterfaces, String targetTechnologySource, String targetTechnologyName, List<String> targetTechnologyInterfaces, List<String> targetTechnologyVersions, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, List<String> recognizedAdditionalProperties, Map<String, String> additionalProperties) Create a connector type entity.- Parameters:
connectorCategoryGUID
- unique identifier of connector category - or null is not categorizedqualifiedName
- unique name for the connector typedisplayName
- display name for the connector typedescription
- description about the connector typesupportedAssetTypeName
- type of asset supported by this connectorexpectedDataFormat
- format of the data stored in the resourceconnectorProviderClassName
- code for this type of connectorconnectorFrameworkName
- name of the framework that the connector implements - default "Open Connector Framework (OCF)"connectorInterfaceLanguage
- programming language of the connector's interfaceconnectorInterfaces
- the interfaces that the connector implementstargetTechnologySource
- organization implementing the target technologytargetTechnologyName
- name of the target technologytargetTechnologyInterfaces
- called interfaces the target technologytargetTechnologyVersions
- supported versions of the target technologyrecognizedSecuredProperties
- names of supported properties hidden from the client - for connection object.recognizedConfigurationProperties
- names of supported properties used to configure the connector - for connection object.recognizedAdditionalProperties
- names of any other properties for connection object.additionalProperties
- any other properties.- Returns:
- id for the connector type
-
addConnectorCategory
public String addConnectorCategory(String connectorTypeDirectoryGUID, String qualifiedName, String displayName, String description, String targetTechnologySource, String targetTechnologyName, Map<String, Boolean> recognizedSecuredProperties, Map<String, Boolean> recognizedConfigurationProperties, Map<String, Boolean> recognizedAdditionalProperties, Map<String, String> additionalProperties) Create a connector category entity.- Parameters:
connectorTypeDirectoryGUID
- unique identifier of connector type directory that this connector belongs to - or null for an independent connector categoryqualifiedName
- unique name for the connector categorydisplayName
- display name for the connector categorydescription
- description about the connector categorytargetTechnologySource
- organization implementing the target technologytargetTechnologyName
- name of the target technologyrecognizedSecuredProperties
- names of supported properties hidden from the client - for connection object.recognizedConfigurationProperties
- names of supported properties used to configure the connector - for connection object.recognizedAdditionalProperties
- names of any other properties for connection object.additionalProperties
- any other properties.- Returns:
- id for the connector type
-
addConnectorTypeDirectory
public String addConnectorTypeDirectory(String qualifiedName, String displayName, String description, Map<String, String> additionalProperties) Create a connector category entity.- Parameters:
qualifiedName
- unique name for the connector type directorydisplayName
- display name for the connector type directorydescription
- description about the connector type directoryadditionalProperties
- any other properties.- Returns:
- id for the connector type
-
addEndpoint
public String addEndpoint(String qualifiedName, String displayName, String description, String networkAddress, String protocol, Map<String, String> additionalProperties) Create a endpoint entity.- Parameters:
qualifiedName
- unique name for the endpointdisplayName
- display name for the endpointdescription
- description about the endpointnetworkAddress
- location of the assetprotocol
- protocol to use to connect to the assetadditionalProperties
- any other properties.- Returns:
- id for the endpoint
-
addGlossary
public String addGlossary(String qualifiedName, String displayName, String description, String language, String usage, String externalLink, String scope) Create a glossary entity. If the external link is specified, the glossary entity is linked to an ExternalGlossaryLink entity. If the scope is specified, the glossary entity is classified as a CanonicalGlossary.- Parameters:
qualifiedName
- unique name for the glossarydisplayName
- display name for the glossarydescription
- description about the glossarylanguage
- language that the glossary is written inusage
- how the glossary should be usedexternalLink
- link to materialscope
- scope of the content.- Returns:
- id for the glossary
-
addGlossary
public String addGlossary(String qualifiedName, String displayName, String description, String language, String usage, String externalLink, String scope, Map<String, String> additionalProperties) Create a glossary entity. If the external link is specified, the glossary entity is linked to an ExternalGlossaryLink entity. If the scope is specified, the glossary entity is classified as a CanonicalGlossary.- Parameters:
qualifiedName
- unique name for the glossarydisplayName
- display name for the glossarydescription
- description about the glossarylanguage
- language that the glossary is written inusage
- how the glossary should be usedexternalLink
- link to materialscope
- scope of the content.additionalProperties
- any other properties.- Returns:
- id for the glossary
-
addCategory
public String addCategory(String glossaryGUID, String qualifiedName, String displayName, String description, String subjectArea) Add a glossary category to the archive and connect it to glossary.- Parameters:
glossaryGUID
- identifier of the glossary.qualifiedName
- unique name for the category.displayName
- display name for the category.description
- description of the category.subjectArea
- name of the subject area if this category contains terms for the subject area.- Returns:
- identifier of the category
-
addCategory
public String addCategory(String glossaryGUID, String qualifiedName, String displayName, String description, String subjectArea, Map<String, String> additionalProperties) Add a glossary category to the archive and connect it to glossary.- Parameters:
glossaryGUID
- identifier of the glossary.qualifiedName
- unique name for the category.displayName
- display name for the category.description
- description of the category.subjectArea
- name of the subject area if this category contains terms for the subject area.additionalProperties
- any other properties.- Returns:
- identifier of the category
-
addTerm
public String addTerm(String glossaryGUID, List<String> categoryGUIDs, String qualifiedName, String displayName, String description) Add a term and link it to the glossary and an arbitrary number of categories.- Parameters:
glossaryGUID
- unique identifier of the glossarycategoryGUIDs
- unique identifiers of the categoriesqualifiedName
- unique name of the termdisplayName
- display name of the termdescription
- description of the term- Returns:
- unique identifier of the term
-
addTerm
public String addTerm(String glossaryGUID, List<String> categoryIds, boolean categoriesAsNames, String qualifiedName, String displayName, String summary, String description, String examples, String abbreviation, String usage, boolean isSpineObject, boolean isSpineAttribute, boolean isContext, String contextDescription, String contextScope, Map<String, String> additionalProperties) Add a term and link it to the glossary and an arbitrary number of categories. Add requested classifications- Parameters:
glossaryGUID
- unique identifier of the glossarycategoryIds
- unique identifiers of the categoriescategoriesAsNames
- when true the categories are specified as qualified names, otherwise they are guids.qualifiedName
- unique name of the termdisplayName
- display name of the termsummary
- short description of the termdescription
- description of the termexamples
- examples of the termabbreviation
- abbreviationusage
- how is the term usedisSpineObject
- term is a spine objectisSpineAttribute
- term is a spine attributeisContext
- is this term a context definition?contextDescription
- description to add to the ContextDefinition classificationcontextScope
- scope to add to the context classificationadditionalProperties
- any other properties.- Returns:
- unique identifier of the term
-
addCategoryToCategory
Link two categories together as part of the parent child hierarchy.- Parameters:
parentCategoryGUID
- unique identifier for the parent categorychildCategoryGUID
- unique identifier for the child category
-
addTermToContext
Link a term to a context referenceable to show that the term is valid in the context of the other.- Parameters:
contextGUID
- unique identifier for the contexttermGUID
- unique identifier for the termstatus
- ordinal for the relationship statusdescription
- description of the relationship between the term and the category.
-
addTermToSynonym
public void addTermToSynonym(String synonymGUID, String termGUID, int status, String description, String expression, String steward, String source) Link two terms together to show that one is valid in the context of the other.- Parameters:
synonymGUID
- unique identifier for the contexttermGUID
- unique identifier for the termstatus
- ordinal for the relationship statusdescription
- description of the relationship between the term and the category.expression
- the expression that indicates how close a synonym this issteward
- the identifier of the steward that created this relationshipsource
- source of the information that indicates this is a synonym
-
addTermToCategory
Link two categories together as part of the parent child hierarchy.- Parameters:
categoryGUID
- unique identifier for the parent categorytermGUID
- unique identifier for the term
-
addTermToCategory
Link two categories together as part of the parent child hierarchy.- Parameters:
categoryGUID
- unique identifier for the parent categorytermGUID
- unique identifier for the termstatus
- ordinal for the relationship statusdescription
- description of the relationship between the term and the category.
-
addLibraryCategoryReference
public void addLibraryCategoryReference(String categoryGUID, String externalGlossaryLinkGUID, String identifier, String description, String steward, Date lastVerified) Link a category to an external glossary link with information on which category in the external glossary it corresponds to.- Parameters:
categoryGUID
- unique identifier for the categoryexternalGlossaryLinkGUID
- unique identifier for the description of the external glossary (a type of external reference)identifier
- identifier of the category in the external glossarydescription
- description of the linksteward
- steward who created linklastVerified
- last time this was verified
-
addLibraryTermReference
public void addLibraryTermReference(String termGUID, String externalGlossaryLinkGUID, String identifier, String description, String steward, Date lastVerified) Link a glossary term to an external glossary link with information on which term in the external glossary it corresponds to.- Parameters:
termGUID
- unique identifier for the termexternalGlossaryLinkGUID
- unique identifier for the description of the external glossary (a type of external reference)identifier
- identifier of the term in the external glossarydescription
- description of the linksteward
- steward who created linklastVerified
- last time this was verified
-
addMoreInformationLink
Create a navigation link from one referenceable to another to show they provide more information.- Parameters:
describedElementId
- unique identifier for the element that is referencing the other.describerElementId
- unique identifier for the element being pointed to.
-
linkTermToReferenceable
Create a semantic assignment between a term and a Referenceable - for example a model element.- Parameters:
termId
- identifier of termreferenceableId
- identifier of referenceable
-
addIsATypeOfRelationship
Add an is-a-type-of relationship- Parameters:
specialTermQName
- qualified name of the specialized termgeneralizedTermQName
- qualified name of the generalized term
-
addHasARelationship
-
addRelatedTermRelationship
-
addValidValue
public String addValidValue(String typeName, String qualifiedName, String displayName, String description, String usage, String scope, String preferredValue, boolean isDeprecated, Map<String, String> additionalProperties) Add a valid value definition/set.- Parameters:
typeName
- unique name of the valid value - ie a definition or a setqualifiedName
- unique name of the valid valuedisplayName
- display name of the valid valuescope
- short description of the valid valuedescription
- description of the valid valuepreferredValue
- preferredValue of the valid valueusage
- how is the valid value usedisDeprecated
- is value activeadditionalProperties
- any other properties.- Returns:
- unique identifier of the valid value
-
addValidValueMembershipRelationship
public void addValidValueMembershipRelationship(String setQName, String memberQName, boolean isDefaultValue) Link a valid value as a member of a valid value set.- Parameters:
setQName
- qualified name of the set to add tomemberQName
- qualified name of the member to addisDefaultValue
- is this the default value (only set to true for one member).
-
addValidValuesAssignmentRelationship
public void addValidValuesAssignmentRelationship(String dataFieldQName, String validValueQName, boolean strictRequirement) Link an element that represents a data field (either directly or indirectly) to a valid value (typically a valid value set).- Parameters:
dataFieldQName
- qualified name of element that represents the data fieldvalidValueQName
- qualified name of the valid value set/definitionstrictRequirement
- do the valid values mandate the values stored in the data field?
-
addValidValuesMappingRelationship
public void addValidValuesMappingRelationship(String matchingValue1QName, String matchingValue2QName, String associationDescription, int confidence, String steward, String stewardTypeName, String stewardPropertyName, String notes) Add a mapping between two valid values. Typically they are in different valid value sets.- Parameters:
matchingValue1QName
- qualified name of one of the valid values.matchingValue2QName
- qualified name of the other valid value.associationDescription
- a description of the meaning of the associationconfidence
- how likely is the relationship correct - 0=unlikely; 100=certaintysteward
- who was the steward that made the linkstewardTypeName
- what is the type of the element used to represent the steward?stewardPropertyName
- what is the name of the property used to represent the steward?notes
- any notes on the relationship.
-
addReferenceValueAssignmentRelationship
public void addReferenceValueAssignmentRelationship(String referenceableQName, String validValueQName, int confidence, String steward, String stewardTypeName, String stewardPropertyName, String notes) Link a referenceable element to a valid value that is acting as a tag.- Parameters:
referenceableQName
- qualified name of referenceablevalidValueQName
- qualified name of valid valueconfidence
- how likely is the relationship correct - 0=unlikely; 100=certaintysteward
- who was the steward that made the linkstewardTypeName
- what is the type of the element used to represent the steward?stewardPropertyName
- what is the name of the property used to represent the steward?notes
- any notes on the relationship.
-
addValidValuesImplementationRelationship
public void addValidValuesImplementationRelationship(String validValueQName, String assetQName, String symbolicName, String implementationValue, Map<String, String> additionalValues) Link a valid value definition to the asset where it is implemented.- Parameters:
validValueQName
- qualified name of the valid valueassetQName
- qualified name of the assetsymbolicName
- property name used in the asset to represent the valid valueimplementationValue
- value used in the asset to represent the valid valueadditionalValues
- additional mapping values
-
addReferenceDataClassification
Add the ReferenceData classification to the requested element.- Parameters:
assetGUID
- unique identifier of the element to classify
-
addSecurityTagsClassification
public void addSecurityTagsClassification(String assetGUID, List<String> securityLabels, Map<String, Object> securityProperties, Map<String, List<String>> accessGroups) Add a SecurityTags classification to the requested element.- Parameters:
assetGUID
- unique identifier for the element to classifysecurityLabels
- list of security labelssecurityProperties
- map of security propertiesaccessGroups
- access group assignments
-