Package org.odpi.openmetadata.commonservices.generichandlers
package org.odpi.openmetadata.commonservices.generichandlers
The generic handlers provide services to translate OMAS requests
built around that service's private beans into calls to the repository
services (through the repository handler).
The aim is to reduce the coding needed in the specific handlers used by the Open Metadata Access Services (OMASs) and
ensuring security and visibility of assets and other sensitive objects are managed correctly.
The OMAS is responsible for providing the bean implementation and
a converter object that can convert the content of entities and
relationships retrieved through the repository services into the
OMAS's beans.
The generic handlers take simple properties on create and update methods.
They pack these properties into InstanceProperties objects and then pass them
to the repository services to update the relevant entities/relationships/classifications
in the repository.
When instances are retrieved through the repository services,
the generic handlers use the OMAS's converters to return the appropriate
beans to return on the API.
The generic handlers also support the linking and unlinking of entities
in the repositories through the maintenance of relationships as well as managing
classifications.
A key part of the capability of the generic handlers is to manage the authorization
calls to Open Metadata Security verifier and to ensure assets (and any linked
entities that are anchored to it making them logically part of its lifecycle)
are only visible when they are members of the supported zones.
Finally, the generic handlers maintain the LatestChange classification on anchor Referenceables
and the Anchors classification vor all entities that are anchored to a referenceable.
-
ClassesClassDescriptionActorProfileBuilder creates the parts for an entity that represents an actor profile.ActorProfileConverter generates a ActorProfileElement bean from a ActorProfile entity.ActorProfileHandler provides the exchange of metadata about actor profiles between the repository and the OMAS.AnnotationBuilder supports the creation of the entities and relationships that describe an Open Discovery Framework (ODF) Annotation.AnnotationConverter transfers the relevant properties from some Open Metadata Repository Services (OMRS) EntityDetail object into an Annotation bean.AnnotationHandler manages the storage and retrieval of metadata relating to annotations as defined in the Survey Action Framework (ODF).AnnotationReviewBuilder supports the creation of the entities and relationships that describe an Governance Action Framework (GAF) AnnotationReview and the link to the annotation.APIConverter<B>APIConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a API bean.EventTypeConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from EventTypeElement.APIOperationHandler provides the exchange of metadata about APIOperation schema types between the repository and the OMAS.APIParameterConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a APIParameterElement bean.EventTypeConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from EventTypeElement.APIParameterListHandler provides the exchange of metadata about APIParameterList schema types between the repository and the OMAS.AssetBuilder creates the parts of a root repository entity for an asset.AssetConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from AssetProperties.AssetHandler<B>AssetHandler manages B objects and optionally connections in the property server.CertificationHandler manages Certification objects.CertificationTypeConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from CertificationTypeElement.CollectionBuilder creates the parts for an entity that represents a collection.CollectionConverter generates a CollectionElement from a Collection entityCollectionHandler provides the exchange of metadata about collections between the repository and the OMAS.CollectionMembershipConverter generates a CollectionBean from a CollectionMembership relationship and Collection entityCommentBuilder is able to build the properties for a Comment entity.CommentConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into an CommentElement bean.CommentHandler manages Comment objects.CommunityBuilder creates the parts for an entity that represents a community.CommunityConverter generates an CommunityElement bean from an CommunityProperties entity.CommunityHandler provides the exchange of metadata about communities between the repository and the OMAS.ConnectionBuilder is able to build the properties for both a Connection entity and a VirtualConnection entity.OCFConnectionConverter transfers the relevant properties from some Open Metadata Repository Services (OMRS) EntityDetail and Relationship objects into a Connection bean (or a VirtualConnection bean).ConnectionHandler manages Connection objects.ConnectorTypeBuilder is able to build the properties for an ConnectorType entity from an ConnectorType bean.ConnectorTypeConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a ConnectorTypeElement bean.ConnectorTypeHandler manages ConnectorType objects.ContactDetailsBuilder is able to build the properties for a ContactDetails entity.ContactDetailHandler manages the ContactDetails entity.ContactMethodConverter generates a ContactMethodProperties bean from a ContactMethodProperties entity.ContributionRecordBuilder is able to build the properties for a ContributionRecord entity.ContributionRecordConverter generates a ContributionRecordProperties bean from a ContributionRecord entity.ContributionRecordHandler manages the ContributionRecord entity that records the karma points for an individual.ControlFlowConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship object into a ControlFlowElement bean.DatabaseColumnConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a DatabaseColumnElement bean.DatabaseConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a DatabaseElement bean.DatabaseManagerConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a SoftwareCapabilityElement bean.DatabaseSchemaConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a DatabaseSchemaElement bean.DatabaseTableConverter transfers the relevant properties from some Open Metadata Repository Services (OMRS) EntityDetail object into an DatabaseTable bean.TabularColumnConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a TabularColumnElement bean.DataContainerConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a DataContainerElement bean.DataFieldConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a DataFieldElement bean.Handler for data fields which are part of discovery reports.DataFileConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a DataFileElement bean.DataFlowConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship object into a DataFlowElement bean.DataManagerOMASConverter provides the generic methods for the Data Manager beans converters.DisplayDataContainerHandler<SCHEMA_ATTRIBUTE,
SCHEMA_TYPE> DisplayDataContainerHandler manages the schemas for display data containers.ElementHeaderConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a ElementHeader bean.ElementStubConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityProxy object into an ElementStub bean.EmbeddedConnectionBuilder is able to build the properties for the relationship between a connection and its embedded connections.EndpointConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a EndpointElement bean.EndpointHandler manages Endpoint objects.EngineActionBuilder creates the parts for an entity that represents an engine action.EngineActionHandler manages EngineAction objects from the Governance Action Framework (GAF).EventTypeConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from EventTypeElement.EventTypeHandler provides the exchange of metadata about EventType schema types between the repository and the OMAS.ExternalIdentifierHandler<EXTERNAL_ID,OPEN_METADATA_ELEMENT_HEADER> ExternalIdentifierHandler manages ExternalIdentifier objects.ExternalReferenceBuilder creates the parts for an entity that represents an external reference.ExternalReferenceConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from ExternalReferenceElement.ExternalReferenceHandler manages ExternalReference objects.ExternalReferenceLinkHandler manages retrieval of ExternalReference objects attached to a specific element.FileFolderConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a FileFolderElement bean.FilesAndFoldersHandler<FILESYSTEM,FOLDER, FILE> FilesAndFoldersHandler provides the support for managing catalog entries about files and folders.FileSystemConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a FileSystemElement bean.FormConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a Form bean.GlossaryBuilder creates the parts for an entity that represents a glossary.GlossaryCategoryBuilder creates the parts for an entity that represents a glossary category.GlossaryCategoryHandler provides the exchange of metadata about glossary categories between the repository and the OMAS.GlossaryHandler provides the exchange of metadata about glossaries between the repository and the OMAS.GlossaryTermBuilder is able to build the properties for a GlossaryTerm entity from a GlossaryTerm bean.GlossaryTermHandler retrieves Glossary Term objects from the property server.GovernanceActionProcessStepBuilder creates the parts for an entity that represents a governance action process step.GovernanceActionProcessStepHandler manages GovernanceActionProcessStep entities and their relationships.GovernanceActionTypeBuilder creates the parts for an entity that represents a governance action type.GovernanceActionTypeHandler manages GovernanceActionType entities and their relationships.GovernanceDefinitionBuilder creates the parts for an entity that represents a governance definition.GovernanceDefinitionConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from GovernanceDefinitionElement.GovernanceDefinitionConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from GovernanceDefinitionGraph.GovernanceDefinitionHandler provides the exchange of metadata about definition definitions between the repository and the OMAS.GovernanceDomainBuilder creates the parts for an entity that represents a GovernanceDomainDescription.GovernanceDomainConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from GovernanceDomainElement.GovernanceDomainHandler provides the exchange of metadata about governance domains between the repository and the OMAS.GovernanceDomainSetConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from GovernanceDomainSetElement.GovernanceMetricBuilder creates the parts for an entity that represents a governance metric.GovernanceMetricConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from GovernanceMetricElement.GovernanceMetricHandler provides the exchange of metadata about governanceMetrics between the repository and the OMAS.GovernanceMetricConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from GovernanceMetricImplementation.GovernanceRoleConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into an GovernanceRoleElement bean.GovernanceZoneBuilder creates the parts for an entity that represents a governance zone definition.GovernanceZoneConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from GovernanceZoneElement.GovernanceZoneHandler provides the exchange of metadata about governance zones between the repository and the OMAS.InformalTagBuilder is able to build the properties for an InformalTag entity.InformalTagConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into an InformalTagElement bean.InformalTagHandler manages InformalTag objects.ITInfrastructureBuilder provides the builder functions for classifications and relationships.OperatingPlatformHandler provides the exchange of metadata about hosts, software server platforms and software servers between the repository and the OMAS.ActorProfileConverter generates a ActorProfileElement bean from a ActorProfile entity.LicenseHandler manages License objects.LicenseTypeConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from LicenseTypeElement.LikeBuilder is able to build the properties for a Like entity.LikeConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into an LikeElement bean.LikeHandler<B>LikeHandler provides access and maintenance for Like objects and their attachment to Referenceables.LineageMappingConverter provides common methods for transferring relevant header from an Open Metadata Repository Services (OMRS) Relationship object into a LineageMappingElement bean.LocationBuilder creates the parts for an entity that represents a location.LocationConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from LocationElement.LocationHandler manages Location objects.MeaningConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a MeaningElement bean.MetadataElementConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a MetadataElementSummary bean.MetadataRelationshipSummaryConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) Relationship object into a MetadataRelationship bean.MetadataSourceConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a MetadataSourceElement bean.NoteBuilder is able to build the properties for a Note entity.NoteHandler<B>NoteLogHandler manages NoteLog objects.NoteLogBuilder is able to build the properties for a NoteLog entity.NoteLogHandler manages NoteLog objects.OCFConnectionConverter transfers the relevant properties from some Open Metadata Repository Services (OMRS) EntityDetail and Relationship objects into a Connection bean (or a VirtualConnection bean).OMFConverter<B>OMFConverter provides the generic methods for the OCF beans converters.OpenMetadataAPIDummyBean is a dummy class for use with Generic Handlers when there is not need to return a real beanOpenMetadataAPIGenericConverter provides the generic methods for the bean converters used to provide translation between specific Open Metadata API beans and the repository services API beans.OpenMetadataAPIGenericBuilder provides the common functions for building new entities, relationships and classifications.OpenMetadataAPIGenericConverter provides the generic methods for the bean converters used to provide translation between specific Open Metadata API beans and the repository services API beans.OpenMetadataAPIGenericHandler manages the exchange of Open Metadata API Bean content with the repository services (via the repository handler).The properties for an Anchors classification.OpenMetadataAPIRootHandler provides the common properties for the generic handlers.OpenMetadataAPITemplateHandler provides the methods for managing the creation of elements using templates.OperatingPlatformBuilder creates the parts for an entity that represents an operating platform (model 0030).OperatingPlatformHandler provides the exchange of metadata about operating platforms between the repository and the OMAS.PersonRoleBuilder creates the parts for an entity that represents a person role plus manages the properties for the relationships.PersonRoleConverter generates a PersonRoleProperties bean from an PersonRoleProperties entity and the relationships connected to it.PersonRoleHandler provides the exchange of metadata about roles between the repository and the OMAS.PortBuilder is able to build the properties for a Port entity.PortConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that includes the PortProperties.PortHandler<B>Manages the maintenance of port entities.ProcessBuilder creates the parts of a root repository entity for a process.ProcessCallConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship object into a bean that includes the ProcessCallProperties.ProcessConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that includes the ProcessProperties.ProcessHandler<PROCESS,PORT, DATA_FLOW, CONTROL_FLOW, PROCESS_CALL, LINEAGE_MAPPING> ProcessHandler provides the methods to create and maintain processes and their contents.ProfileConverter generates a ProfileElement bean from a ActorProfileProperties entity.ProjectBuilder creates the parts for an entity that represents a Project.ProjectConverter generates an ProjectCollectionMember bean from an Project entity and a ResourceList relationship to it.ProjectHandler provides the exchange of metadata about projects between the repository and the OMAS.PropertyFacetBuilder is able to build the properties for a SearchKeyword entity.QueryConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a Query bean.RatingBuilder is able to build the properties for a Rating entity.RatingConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into an RatingElement bean.RatingHandler manages the Rating entity.ReferenceableBuilder creates Open Metadata Repository Services (OMRS) objects based on the bean properties supplied in the constructor.ReferenceableConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from ReferenceableProperties.ReferenceableHandler manages methods on generic referenceables.ReferenceDataHandler<VALID_VALUE,VALID_VALUE_ASSIGNMENT, VALID_VALUE_ASSIGNMENT_DEF, VALID_VALUE_IMPLEMENTATION, VALID_VALUE_IMPLEMENTATION_DEF, VALID_VALUE_MAPPING, REFERENCE_VALUE_ASSIGNMENT, REFERENCE_VALUE_ASSIGNED_ITEM> ReferenceDataHandler provides the methods to create and maintain lists of valid value definitions grouped into a valid value set.ReferenceValueAssignmentDefinitionConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship and linked EntityDetail object into a bean that inherits from ReferenceValueAssignmentDefinitionElement.ReferenceValueAssignmentItemConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship and linked EntityDetail object into a bean that inherits from ReferenceValueAssignmentItemElement.RelatedAssetConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship and EntityDetail object into a bean that inherits from RelatedAssetElement.RelatedAssetHandler manages B objects and optionally connections in the property server.RelatedElementConverter generates a RelatedElement from a relationship and attached entityRelatedMediaHandler manages RelatedMedia objects.RelationalDataHandler<DATABASE,DATABASE_SCHEMA, DATABASE_TABLE, DATABASE_VIEW, DATABASE_COLUMN, SCHEMA_TYPE> RelationalDataHandler manages the assets and schemas for relational data.ReportConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a Report bean.SAFConverter<B>ODFConverter provides the generic methods for the Data Manager beans converters.SchemaAttributeBuilder creates instance properties for a schema attribute.SchemaAttributeConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a SchemaAttributeElement bean.SchemaAttributeHandler<SCHEMA_ATTRIBUTE,SCHEMA_TYPE> SchemaAttributeHandler manages Schema Attribute objects.SchemaTypeBuilder manages the properties for a schema type.SchemaTypeConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a SchemaTypeElement bean.SchemaTypeHandler manages SchemaType objects.SearchKeywordBuilder is able to build the properties for a SearchKeyword entity.SearchKeywordHandler manages SearchKeyword objects.GovernanceDefinitionConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from GovernanceDefinition.SecurityManagerConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a SecurityManagerElement bean.SoftwareCapabilityBuilder creates the parts for an entity that represents a software capability.SoftwareCapabilityConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a SoftwareCapabilityElement bean.SoftwareCapabilityHandler provides the support for managing software capabilities.SubjectAreaBuilder creates the parts for an entity that represents a subject area definition.SubjectAreaConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from SubjectAreaElement.SubjectAreaHandler provides the exchange of metadata about subject areas between the repository and the OMAS.SurveyReportBuilder supports the creation of the entities and relationships that describe a Survey Analysis Framework (SAF) Survey Report.SurveyReportConverter transfers the relevant properties from some Open Metadata Repository Services (OMRS) EntityDetail object into an SurveyReport bean.SurveyReportHandler manages the storage and retrieval of metadata relating to survey reports as defined in the Survey Analysis Framework (SAF).TabularColumnConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a TabularColumnElement bean.TopicConverter transfers the relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a TopicElement bean.UserIdentityBuilder creates the parts for an entity that represents a user identity.UserIdentityConverter generates an UserIdentityElement bean from an UserIdentity entity.UserIdentityHandler provides the exchange of metadata about users between the repository and the OMAS.ValidValueAssignmentConsumerConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship and linked EntityDetail object into a bean that inherits from ValidValueAssignmentConsumerElement.ValidValueAssignmentDefinitionConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship and linked EntityDetail object into a bean that inherits from ValidValueAssignmentDefinitionElement.ValidValueConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a bean that inherits from ValidValueElement.ValidValueImplAssetConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship and linked EntityDetail object into a bean that inherits from ValidValueImplAssetElement.ValidValueImplDefinitionConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship and linked EntityDetail object into a bean that inherits from ValidValueImplDefinitionElement.ReferenceValueAssignmentDefinitionConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) Relationship and linked EntityDetail object into a bean that inherits from ReferenceValueAssignmentDefinitionElement.ValidValuesBuilder is used to manage the properties of a valid values set and definition.ValidValueConverter provides common methods for transferring relevant properties from an Open Metadata Repository Services (OMRS) EntityDetail object into a ValidValueElement bean.ValidValuesHandler provides the methods to create and maintain lists of valid value definitions grouped into a valid value set.