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) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
void	addLineageMappingRelationship(String userId, String sourceSchemaAttributeQualifiedName, String targetSchemaAttributeQualifiedName, String externalSourceName) Create LineageMapping relationship between two schema attribute types
String	createOrUpdateSchemaType(String userId, String qualifiedName, String displayName, String author, String encodingStandard, String usage, String versionNumber, List<Attribute> attributeList, String externalSourceName) Create the schema type entity, with the corresponding schema attributes and relationships
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)

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

Method Detail

createOrUpdateSchemaType

public String createOrUpdateSchemaType(String userId,
                                       String qualifiedName,
                                       String displayName,
                                       String author,
                                       String encodingStandard,
                                       String usage,
                                       String versionNumber,
                                       List<Attribute> attributeList,
                                       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

qualifiedName - the qualifiedName name of the schema type

displayName - the display name of the schema type

author - the author of the schema type

encodingStandard - the encoding for the schema type

usage - the usage for the schema type

versionNumber - the version number for the schema type

attributeList - the list of attributes for the schema type

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

addLineageMappingRelationship

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

Create LineageMapping relationship between two schema attribute types

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