org.odpi.openmetadata.accessservices.dataengine.client

Interface DataEngineClient

All Known Implementing Classes:

DataEngineImpl

public interface DataEngineClient

DataEngineClient provides the client-side interface for a data engine tool to create processes with ports, schemas and relationships.

Method Summary

Modifier and Type	Method and Description
void	addLineageMappings(String userId, List<LineageMapping> lineageMappings) Add lineage mapping relationships between schema types
void	addPortsToProcess(String userId, List<String> portGUIDs, String processGUID) Add ports and process ports relationship to an existing port
String	createExternalDataEngine(String userId, SoftwareServerCapability softwareServerCapability) Create or update the software server capability entity
String	createExternalDataEngine(String userId, String qualifiedName, String name, String description, String type, String version, String patchLevel, String source) Create or update the software server capability entity
String	createOrUpdatePortAlias(String userId, PortAlias portAlias) Create or update the port alias entity with a PortDelegation relationship
String	createOrUpdatePortAlias(String userId, String qualifiedName, String displayName, PortType portType, String delegatesTo) Create or update the port alias entity with a PortDelegation relationship
String	createOrUpdatePortImplementation(String userId, PortImplementation portImplementation) Create or update the port implementation entity,with the corresponding schema type and port schema relationship
String	createOrUpdatePortImplementation(String userId, String qualifiedName, String displayName, PortType portType, SchemaType schemaType) Create or update the port implementation entity, with the corresponding schema type and port schema relationship.
String	createOrUpdatePortImplementation(String userId, String qualifiedName, String displayName, PortType portType, SchemaType schemaType, UpdateSemantic updateSemantic) Create or update the port implementation entity, with the corresponding schema type and port schema relationship
String	createOrUpdateProcess(String userId, Process process) Create or update the process, with all the ports, schema types and corresponding relationships
String	createOrUpdateProcess(String userId, String qualifiedName, String processName, String description, String latestChange, List<String> zoneMembership, String displayName, String formula, String owner, OwnerType ownerType, List<PortImplementation> portImplementations, List<PortAlias> portAliases, List<LineageMapping> lineageMappings) Create or update the process, with all the ports, schema types and corresponding relationships.
String	createOrUpdateProcess(String userId, String qualifiedName, String processName, String description, String latestChange, List<String> zoneMembership, String displayName, String formula, String owner, OwnerType ownerType, List<PortImplementation> portImplementations, List<PortAlias> portAliases, List<LineageMapping> lineageMappings, UpdateSemantic updateSemantic) Create or update the process, with all the ports, schema types and corresponding relationships
List<String>	createOrUpdateProcesses(String userId, List<Process> processes) Create or update the processes, with all the ports, schema types and corresponding relationships
String	createOrUpdateSchemaType(String userId, SchemaType schemaType) Create or update the schema type entity, with the corresponding schema attributes and relationships
String	createOrUpdateSchemaType(String userId, String qualifiedName, String displayName, String author, String encodingStandard, String usage, String versionNumber, List<Attribute> attributeList) Create or update the schema type entity, with the corresponding schema attributes and relationships

Method Detail

createOrUpdateProcess

String createOrUpdateProcess(String userId,
                             String qualifiedName,
                             String processName,
                             String description,
                             String latestChange,
                             List<String> zoneMembership,
                             String displayName,
                             String formula,
                             String owner,
                             OwnerType ownerType,
                             List<PortImplementation> portImplementations,
                             List<PortAlias> portAliases,
                             List<LineageMapping> lineageMappings,
                             UpdateSemantic updateSemantic)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Create or update the process, with all the ports, schema types and corresponding relationships

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the process

processName - the name of the process

description - the description of the process

latestChange - the description for the latest change done for the process

zoneMembership - the list of zones of the process

displayName - the display name of the process

formula - the formula for the process

owner - the name of the owner for this process

ownerType - the type of the owner for this process

portImplementations - the list of port implementations

portAliases - the list of port aliases

lineageMappings - the list of lineage mappings

updateSemantic - the update type for the process

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

createOrUpdateProcess

String createOrUpdateProcess(String userId,
                             String qualifiedName,
                             String processName,
                             String description,
                             String latestChange,
                             List<String> zoneMembership,
                             String displayName,
                             String formula,
                             String owner,
                             OwnerType ownerType,
                             List<PortImplementation> portImplementations,
                             List<PortAlias> portAliases,
                             List<LineageMapping> lineageMappings)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Create or update the process, with all the ports, schema types and corresponding relationships. Uses the default UpdateSemantic.REPLACE on update

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the process

processName - the name of the process

description - the description of the process

latestChange - the description for the latest change done for the process

zoneMembership - the list of zones of the process

displayName - the display name of the process

formula - the formula for the process

owner - the name of the owner for this process

ownerType - the type of the owner for this process

portImplementations - the list of port implementations

portAliases - the list of port aliases

lineageMappings - the list of lineage mappings

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

See Also:

UpdateSemantic

createOrUpdateProcess

String createOrUpdateProcess(String userId,
                             Process process)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Create or update the process, with all the ports, schema types and corresponding relationships

Parameters:

userId - the name of the calling user

process - the process bean

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

createOrUpdateProcesses

List<String> createOrUpdateProcesses(String userId,
                                     List<Process> processes)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Create or update the processes, with all the ports, schema types and corresponding relationships

Parameters:

userId - the name of the calling user

processes - list of processes

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

createExternalDataEngine

String createExternalDataEngine(String userId,
                                String qualifiedName,
                                String name,
                                String description,
                                String type,
                                String version,
                                String patchLevel,
                                String source)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Create or update the software server capability entity

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the server

name - the name of the server

description - the description of the server

type - the type of the server

version - the version of the server

patchLevel - the patch level of the server

source - the source of the server

Returns:

unique identifier of the server in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createExternalDataEngine

String createExternalDataEngine(String userId,
                                SoftwareServerCapability softwareServerCapability)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Create or update the software server capability entity

Parameters:

userId - the name of the calling user

softwareServerCapability - the software server capability bean

Returns:

unique identifier of the server in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createOrUpdateSchemaType

String createOrUpdateSchemaType(String userId,
                                String qualifiedName,
                                String displayName,
                                String author,
                                String encodingStandard,
                                String usage,
                                String versionNumber,
                                List<Attribute> attributeList)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Create or update 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

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

createOrUpdateSchemaType

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

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

Parameters:

userId - the name of the calling user

schemaType - the schema type bean

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

createOrUpdatePortImplementation

String createOrUpdatePortImplementation(String userId,
                                        String qualifiedName,
                                        String displayName,
                                        PortType portType,
                                        SchemaType schemaType)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Create or update the port implementation entity, with the corresponding schema type and port schema relationship. Uses the default UpdateSemantic.REPLACE on update

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the port

displayName - the display name of the port

portType - the type of the port

schemaType - the schema type attached to the port implementation

Returns:

unique identifier of the port implementation in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

See Also:

UpdateSemantic

createOrUpdatePortImplementation

String createOrUpdatePortImplementation(String userId,
                                        String qualifiedName,
                                        String displayName,
                                        PortType portType,
                                        SchemaType schemaType,
                                        UpdateSemantic updateSemantic)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Create or update the port implementation entity, with the corresponding schema type and port schema relationship

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the port

displayName - the display name of the port

portType - the type of the port

schemaType - the schema type attached to the port implementation

updateSemantic - the update type for the schema type

Returns:

unique identifier of the port implementation in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createOrUpdatePortImplementation

String createOrUpdatePortImplementation(String userId,
                                        PortImplementation portImplementation)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Create or update the port implementation entity,with the corresponding schema type and port schema relationship

Parameters:

userId - the name of the calling user

portImplementation - the port implementation bean

Returns:

unique identifier of the port implementation in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createOrUpdatePortAlias

String createOrUpdatePortAlias(String userId,
                               String qualifiedName,
                               String displayName,
                               PortType portType,
                               String delegatesTo)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create or update the port alias entity with a PortDelegation relationship

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the port

displayName - the display name of the port

portType - the type of the port

delegatesTo - the qualified name of the delegated port

Returns:

unique identifier of the port alias in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createOrUpdatePortAlias

String createOrUpdatePortAlias(String userId,
                               PortAlias portAlias)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create or update the port alias entity with a PortDelegation relationship

Parameters:

userId - the name of the calling user

portAlias - the port alias bean

Returns:

unique identifier of the port alias in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addLineageMappings

void addLineageMappings(String userId,
                        List<LineageMapping> lineageMappings)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Add lineage mapping relationships between schema types

Parameters:

userId - the name of the calling user

lineageMappings - list of lineage mappings

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addPortsToProcess

void addPortsToProcess(String userId,
                       List<String> portGUIDs,
                       String processGUID)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Add ports and process ports relationship to an existing port

Parameters:

userId - the name of the calling user

portGUIDs - the list of port GUIDs

processGUID - the process GUYID

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server