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

Class DataEngineCollectionHandler

java.lang.Object

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

public class DataEngineCollectionHandler
extends Object

DataEngineCollectionHandler manages collection objects. It runs server-side in the DataEngine OMAS and creates and retrieves collections entities through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor	Description
DataEngineCollectionHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, OpenMetadataAPIGenericHandler<Collection> collectionOpenMetadataAPIGenericHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler)	Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method	Description
void	addCollectionMembershipRelationship(String userId, String processGUID, String collectionGUID, String externalSourceName)	Create CollectionMembership relationships between a Process asset and a Collection.
String	createCollection(String userId, Collection collection, String externalSourceName)	Create the schema type entity, with the corresponding schema attributes and relationships if it doesn't exist or updates the existing one.
Optional<EntityDetail>	findCollectionEntity(String userId, String qualifiedName)	Find out if the Transformation Project object is already stored in the repository as a Collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineCollectionHandler

public DataEngineCollectionHandler(String serviceName,
                                   String serverName,
                                   InvalidParameterHandler invalidParameterHandler,
                                   OMRSRepositoryHelper repositoryHelper,
                                   OpenMetadataAPIGenericHandler<Collection> collectionOpenMetadataAPIGenericHandler,
                                   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

repositoryHelper - provides utilities for manipulating the repository services objects

dataEngineRegistrationHandler - provides calls for retrieving external data engine guid

dataEngineCommonHandler - provides utilities for manipulating entities

collectionOpenMetadataAPIGenericHandler - helps building model for creating Collection metadata associated with Process assets

Method Detail

createCollection

public String createCollection(String userId,
                               Collection collection,
                               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

collection - the collection 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

findCollectionEntity

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

Find out if the Transformation Project object is already stored in the repository as a Collection. 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

addCollectionMembershipRelationship

public void addCollectionMembershipRelationship(String userId,
                                                String processGUID,
                                                String collectionGUID,
                                                String externalSourceName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Create CollectionMembership relationships between a Process asset and a Collection. Verifies that the relationship is not present before creating it

Parameters:

userId - the name of the calling user

processGUID - the unique identifier of the process

collectionGUID - the unique identifier of the collection

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