org.odpi.openmetadata.accessservices.dataengine.server.handlers

Class DataEngineSchemaTypeHandler

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEngineSchemaTypeHandler

public class DataEngineSchemaTypeHandler
extends Object

DataEngineSchemaTypeHandler manages schema types objects from the property server. It runs server-side in the DataEngine OMAS and creates and retrieves schema type entities through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor and Description

DataEngineSchemaTypeHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, SchemaTypeHandler schemaTypeHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
void	addAnchorGUID(String userId, Attribute attribute, String processGUID) Updates the schema attribute with anchorGUID property set to process GUID
void	addLineageMappingRelationship(String userId, String sourceSchemaAttributeQualifiedName, String targetSchemaAttributeQualifiedName, String externalSourceName) Create LineageMapping relationship between two schema attributes
String	createOrUpdateSchemaType(String userId, SchemaType schemaType, String externalSourceName) Create the schema type entity, with the corresponding schema attributes and relationships
Optional<EntityDetail>	findSchemaAttributeEntity(String userId, String qualifiedName) Find out if the SchemaAttribute object is already stored in the repository.
Optional<EntityDetail>	findSchemaTypeEntity(String userId, String qualifiedName) Find out if the SchemaType object is already stored in the repository.
void	removeSchemaType(String userId, String schemaTypeGUID) Remove the schema type with the associated schema attributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataEngineSchemaTypeHandler

public DataEngineSchemaTypeHandler(String serviceName,
                                   String serverName,
                                   InvalidParameterHandler invalidParameterHandler,
                                   RepositoryHandler repositoryHandler,
                                   OMRSRepositoryHelper repositoryHelper,
                                   SchemaTypeHandler schemaTypeHandler,
                                   DataEngineRegistrationHandler dataEngineRegistrationHandler,
                                   DataEngineCommonHandler dataEngineCommonHandler)

Construct the handler information needed to interact with the repository services

Parameters:

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

dataEngineRegistrationHandler - provides calls for retrieving external data engine guid

dataEngineCommonHandler - provides utilities for manipulating entities

Method Detail

createOrUpdateSchemaType

public String createOrUpdateSchemaType(String userId,
                                       SchemaType schemaType,
                                       String externalSourceName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Create the schema type entity, with the corresponding schema attributes and relationships

Parameters:

userId - the name of the calling user

schemaType - the schema type values

externalSourceName - the unique name of the external source

Returns:

unique identifier of the schema type in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

findSchemaTypeEntity

public Optional<EntityDetail> findSchemaTypeEntity(String userId,
                                                   String qualifiedName)
                                            throws UserNotAuthorizedException,
                                                   PropertyServerException,
                                                   InvalidParameterException

Find out if the SchemaType object is already stored in the repository. It uses the fully qualified name to retrieve the entity

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the process to be searched

Returns:

optional with entity details if found, empty optional if not found

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

findSchemaAttributeEntity

public Optional<EntityDetail> findSchemaAttributeEntity(String userId,
                                                        String qualifiedName)
                                                 throws UserNotAuthorizedException,
                                                        PropertyServerException,
                                                        InvalidParameterException

Find out if the SchemaAttribute object is already stored in the repository. It uses the fully qualified name to retrieve the entity

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the process to be searched

Returns:

optional with entity details if found, empty optional if not found

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addLineageMappingRelationship

public void addLineageMappingRelationship(String userId,
                                          String sourceSchemaAttributeQualifiedName,
                                          String targetSchemaAttributeQualifiedName,
                                          String externalSourceName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Create LineageMapping relationship between two schema attributes

Parameters:

userId - the name of the calling user

sourceSchemaAttributeQualifiedName - the qualified name of the source schema attribute

targetSchemaAttributeQualifiedName - the qualified name of the target schema attribute

externalSourceName - the unique name of the external source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeSchemaType

public void removeSchemaType(String userId,
                             String schemaTypeGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Remove the schema type with the associated schema attributes

Parameters:

userId - the name of the calling user

schemaTypeGUID - the unique identifier of the schema type

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addAnchorGUID

public void addAnchorGUID(String userId,
                          Attribute attribute,
                          String processGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Updates the schema attribute with anchorGUID property set to process GUID

Parameters:

userId - the name of the calling user

attribute - the properties of the schema attribute

processGUID - the GUID of the process

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server