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

Class DataEngineCommonHandler

java.lang.Object

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

public class DataEngineCommonHandler
extends Object

DataEngineCommonHandler manages objects from the property server. It runs server-side in the DataEngine OMAS and creates port entities with wire relationships through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor and Description
DataEngineCommonHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, DataEngineRegistrationHandler dataEngineRegistrationHandler) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
protected EntityDetail	buildEntityDetail(String entityGUID, InstanceProperties instanceProperties) Build an EntityDetail object based on the instance properties on an entity bean
protected Relationship	buildRelationship(String entityGUID, InstanceProperties instanceProperties) Build an Relationship object based on the instance properties of a relationship
protected String	createExternalEntity(String userId, InstanceProperties instanceProperties, InstanceStatus instanceStatus, String entityTypeName, String externalSourceName) Create a new entity from an external source with the specified instance status
protected void	createOrUpdateExternalRelationship(String userId, String firstGUID, String secondGUID, String relationshipTypeName, String firstEntityTypeName, String externalSourceName, InstanceProperties relationshipProperties) Create or updates an external relationship between two entities.
protected Optional<EntityDetail>	findEntity(String userId, String qualifiedName, String entityTypeName) Find out if the entity is already stored in the repository.
protected void	removeEntity(String userId, String entityGUID, String entityTypeName) Remove entity
protected void	throwInvalidParameterException(DataEngineErrorCode errorCode, String methodName, String... params)
protected void	updateEntity(String userId, String entityGUID, InstanceProperties instanceProperties, String entityTypeName) Update an existing entity

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineCommonHandler

public DataEngineCommonHandler(String serviceName,
                               String serverName,
                               InvalidParameterHandler invalidParameterHandler,
                               RepositoryHandler repositoryHandler,
                               OMRSRepositoryHelper repositoryHelper,
                               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

createExternalEntity

protected String createExternalEntity(String userId,
                                      InstanceProperties instanceProperties,
                                      InstanceStatus instanceStatus,
                                      String entityTypeName,
                                      String externalSourceName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Create a new entity from an external source with the specified instance status

Parameters:

userId - the name of the calling user

instanceProperties - the properties of the entity

instanceStatus - initial status (needs to be valid for type)

entityTypeName - name of the entity's type

externalSourceName - the unique name of the external source

Returns:

unique identifier of the process in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

updateEntity

protected void updateEntity(String userId,
                            String entityGUID,
                            InstanceProperties instanceProperties,
                            String entityTypeName)
                     throws UserNotAuthorizedException,
                            PropertyServerException

Update an existing entity

Parameters:

userId - the name of the calling user

entityGUID - unique identifier of entity to update

instanceProperties - the properties of the entity

entityTypeName - name of the entity's type

Throws:

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

buildEntityDetail

protected EntityDetail buildEntityDetail(String entityGUID,
                                         InstanceProperties instanceProperties)

Build an EntityDetail object based on the instance properties on an entity bean

Parameters:

entityGUID - unique identifier of entity to update

instanceProperties - the properties of the entity

Returns:

an EntityDetail object containing the entity properties

buildRelationship

protected Relationship buildRelationship(String entityGUID,
                                         InstanceProperties instanceProperties)

Build an Relationship object based on the instance properties of a relationship

Parameters:

entityGUID - unique identifier of entity to update

instanceProperties - the properties of the relationship

Returns:

an Relationship object containing the entity properties

findEntity

protected Optional<EntityDetail> findEntity(String userId,
                                            String qualifiedName,
                                            String entityTypeName)
                                     throws UserNotAuthorizedException,
                                            PropertyServerException,
                                            InvalidParameterException

Find out if the entity 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 entity 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

createOrUpdateExternalRelationship

protected void createOrUpdateExternalRelationship(String userId,
                                                  String firstGUID,
                                                  String secondGUID,
                                                  String relationshipTypeName,
                                                  String firstEntityTypeName,
                                                  String externalSourceName,
                                                  InstanceProperties relationshipProperties)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Create or updates an external relationship between two entities. Verifies that the relationship is not present before creating it. If the relationship is present, verifies the instanceProperties for the relationship to be updated.

Parameters:

userId - the name of the calling user

firstGUID - the unique identifier of the entity at first end

secondGUID - the unique identifier of the entity at second end

relationshipTypeName - type name for the relationship to create

firstEntityTypeName - type name for the entity at first end

externalSourceName - the unique name of the external source

relationshipProperties - the properties for the relationship

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeEntity

protected void removeEntity(String userId,
                            String entityGUID,
                            String entityTypeName)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Remove entity

Parameters:

userId - the name of the calling user

entityGUID - the unique identifier of the port to be removed

entityTypeName - the type name of the entity

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

throwInvalidParameterException

protected void throwInvalidParameterException(DataEngineErrorCode errorCode,
                                              String methodName,
                                              String... params)
                                       throws InvalidParameterException

Throws:

InvalidParameterException