Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	SCHEMA_TYPE_GUID_PARAMETER_NAME

Constructor Summary

Constructors

Constructor	Description
DataEngineSchemaTypeHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, SchemaTypeHandler<SchemaType> schemaTypeHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler, DataEngineSchemaAttributeHandler dataEngineSchemaAttributeHandler)	Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method	Description
void	addDataFlowRelationship(String userId, String dataSupplierQualifiedName, String dataConsumerQualifiedName, String externalSourceName, String formula, String description)	Create DataFlow relationship between two entities
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, String externalSourceName, DeleteSemantic deleteSemantic)	Remove the schema type with the associated schema attributes
String	upsertSchemaType(String userId, SchemaType schemaType, String anchorGUID, String externalSourceName)	Create the schema type entity, with the corresponding schema attributes and relationships if it doesn't exist or updates the existing one.

Methods inherited from class java.lang.Object

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

Field Details

SCHEMA_TYPE_GUID_PARAMETER_NAME

protected static final String SCHEMA_TYPE_GUID_PARAMETER_NAME

See Also:

• Constant Field Values

Constructor Details

DataEngineSchemaTypeHandler

public DataEngineSchemaTypeHandler(String serviceName,
 String serverName,
 InvalidParameterHandler invalidParameterHandler,
 OMRSRepositoryHelper repositoryHelper,
 SchemaTypeHandler<SchemaType> schemaTypeHandler,
 DataEngineRegistrationHandler dataEngineRegistrationHandler,
 DataEngineCommonHandler dataEngineCommonHandler,
 DataEngineSchemaAttributeHandler dataEngineSchemaAttributeHandler)

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

repositoryHelper - provides utilities for manipulating the repository services objects

schemaTypeHandler - handler for managing schema elements in the metadata repositories

dataEngineRegistrationHandler - provides calls for retrieving external data engine guid

dataEngineCommonHandler - provides utilities for manipulating entities

dataEngineSchemaAttributeHandler - provides utilities for manipulating schema attributes

Method Details

upsertSchemaType

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

Create the schema type entity, with the corresponding schema attributes and relationships if it doesn't exist or updates the existing one.

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 schema type 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

addDataFlowRelationship

public void addDataFlowRelationship(String userId,
 String dataSupplierQualifiedName,
 String dataConsumerQualifiedName,
 String externalSourceName,
 String formula,
 String description)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create DataFlow relationship between two entities

Parameters:

userId - the name of the calling user

dataSupplierQualifiedName - the qualified name of the data supplier entity

dataConsumerQualifiedName - the qualified name of the data consumer entity

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,
 String externalSourceName,
 DeleteSemantic deleteSemantic)
                      throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
FunctionNotSupportedException

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

externalSourceName - the external data engine

deleteSemantic - the delete semantic

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

FunctionNotSupportedException - the repository does not support this call.