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

Class DataEngineRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.server.service.DataEngineRESTServices

public class DataEngineRESTServices
extends Object

The DataEngineRESTServices provides the server-side implementation of the Data Engine Open Metadata Assess Service (OMAS). This service provide the functionality to create processes, ports with schema types and corresponding relationships.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATABASE_PARAMETER_NAME
static final String	DATABASE_SCHEMA_PARAMETER_NAME
static final String	EXTERNAL_SOURCE_NAME_PARAMETER_NAME
static final String	PROCESSING_STATE
static final String	RELATIONAL_TABLE_PARAMETER_NAME
static final String	SCHEMA
static final String	SCHEMA_SUFFIX
static final String	TOPIC_PARAMETER_NAME
static final String	UPSERT_METHOD_CALLS_FOR

Constructor Summary

Constructors

Constructor	Description
DataEngineRESTServices()

Method Summary

Modifier and Type	Method	Description
void	addDataFlows(String userId, String serverName, List<DataFlow> dataFlows, FFDCResponseBase response, String externalSourceName)	Create DataFlows relationships between schema attributes
VoidResponse	addDataFlows(String userId, String serverName, DataFlowsRequestBody dataFlowsRequestBody)	Create DataFlow relationships between schema attributes
GUIDResponse	addProcessHierarchy(String userId, String serverName, ProcessHierarchyRequestBody processHierarchyRequestBody)	Add the provided ProcessHierarchy relationship
String	addProcessHierarchyToProcess(String userId, String serverName, ProcessHierarchy processHierarchy, String externalSourceName)	Add a a ProcessHierarchy relationship to the process
String	createExternalDataEngine(String userId, String serverName, Engine engine)	Create the external data engine as engine entity
GUIDResponse	createExternalDataEngine(String serverName, String userId, DataEngineRegistrationRequestBody requestBody)	Create the external data engine as engine entity
void	deleteConnection(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the Connection
VoidResponse	deleteConnection(String userId, String serverName, DeleteRequestBody requestBody)	Delete the Connection
void	deleteDatabase(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the Database with all the associated relational tables
VoidResponse	deleteDatabase(String userId, String serverName, DeleteRequestBody requestBody)	Delete the Database with all the associated relational tables
void	deleteDatabaseSchema(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the DatabaseSchema with all the associated relational tables
VoidResponse	deleteDatabaseSchema(String userId, String serverName, DeleteRequestBody requestBody)	Delete the DatabaseSchema with all the associated relational tables
void	deleteDataFile(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the Data File with all the associated Tabular Columns
VoidResponse	deleteDataFile(String userId, String serverName, DeleteRequestBody requestBody)	Delete the Data File with all the associated Tabular Columns
void	deleteEndpoint(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the Endpoint
VoidResponse	deleteEndpoint(String userId, String serverName, DeleteRequestBody requestBody)	Delete the Endpoint
void	deleteEventType(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the EventType with all the associated event schema attributes
VoidResponse	deleteEventType(String userId, String serverName, DeleteRequestBody requestBody)	Delete the EventType with all the associated event schema attributes
void	deleteExternalDataEngine(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the external data engine.
VoidResponse	deleteExternalDataEngine(String userId, String serverName, DeleteRequestBody requestBody)	Delete the external data engine.
void	deleteFolder(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the File Folder
VoidResponse	deleteFolder(String userId, String serverName, DeleteRequestBody requestBody)	Delete the File Folder
void	deletePort(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, String portType, DeleteSemantic deleteSemantic)	Delete the Port with the associated schema type and relationships
VoidResponse	deletePort(String userId, String serverName, DeleteRequestBody requestBody, String portType)	Delete the Port with the associated schema type and relationships
void	deleteProcess(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)
VoidResponse	deleteProcess(String userId, String serverName, DeleteRequestBody requestBody)	Delete a process, with the associated port implementations, port aliases and data flows
void	deleteRelationalTable(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the Relational Table with all the associated Relational Columns
VoidResponse	deleteRelationalTable(String userId, String serverName, DeleteRequestBody requestBody)	Delete the Relational Table with all the associated Relational Columns
void	deleteSchemaType(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the SchemaType with schema attributes and corresponding relationships
VoidResponse	deleteSchemaType(String userId, String serverName, DeleteRequestBody requestBody)	Delete the SchemaType with schema attributes and corresponding relationships
void	deleteTopic(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)	Delete the Topic with all the associated event types
VoidResponse	deleteTopic(String userId, String serverName, DeleteRequestBody requestBody)	Delete the Topic with all the associated event types
GUIDListResponse	find(String userId, String serverName, FindRequestBody findRequestBody)	Performs a find for a DataEngine related object
Optional<EntityDetail>	getEntityDetails(String serverName, String userId, String qualifiedName, String typeName)	Get the entity details of an entity
Optional<String>	getEntityGUID(String serverName, String userId, String qualifiedName, String typeName)	Get the unique identifier of an entity
GUIDResponse	getExternalDataEngine(String serverName, String userId, String qualifiedName)	Get the unique identifier from a external data engine qualified name
ConnectionResponse	getInTopicConnection(String serverName, String userId)	Retrieve in topic connection details from the service instance hosting Data Engine access service
PropertiesResponse	getProcessingState(String userId, String serverName, String externalSourceName)
String	getTopicGUID(String userId, String serverName, String topicQualifiedName, String methodName)	Get the unique identifier of a topic
VoidResponse	updateProcessStatus(String userId, String serverName, String processGUID, InstanceStatus instanceStatus, String externalSourceName)
String	upsertDatabase(String userId, String serverName, Database database, String externalSourceName)	Create or update the Database with corresponding associated schema type and relationship
GUIDResponse	upsertDatabase(String userId, String serverName, DatabaseRequestBody databaseRequestBody)	Create or update the Database with corresponding associated schema type and relationship
String	upsertDatabaseSchema(String userId, String serverName, String databaseQualifiedName, DatabaseSchema databaseSchema, String externalSourceName)	Create or update the DatabaseSchema with corresponding relationship to the database, if provided and not virtual
GUIDResponse	upsertDatabaseSchema(String userId, String serverName, DatabaseSchemaRequestBody databaseSchemaRequestBody)	Create or update the Database Schema with corresponding related entities and classifications
String	upsertDataFile(String userId, String serverName, DataFile file, String externalSourceName)	Updates or inserts a DataFile or CSVFile, along with its schema, columns and folder hierarchy
GUIDResponse	upsertDataFile(String serverName, String userId, DataFileRequestBody dataFileRequestBody)	Updates or inserts a DataFile or CSVFile, along with its schema, columns and folder hierarchy
String	upsertEventType(String userId, String serverName, EventType eventType, String topicGUID, String externalSourceName)	Create or update the EventType with corresponding event schema attributes
GUIDResponse	upsertEventType(String userId, String serverName, EventTypeRequestBody eventTypeRequestBody)	Create or update the EventType with corresponding associated event schema attributes
GUIDResponse	upsertPortAlias(String userId, String serverName, PortAliasRequestBody portAliasRequestBody)	Create or update the Port Alias with a PortDelegation relationship
String	upsertPortAliasWithDelegation(String userId, String serverName, PortAlias portAlias, String processGUID, String externalSourceName)	Create or update a Port Alias with a PortDelegation relationship
String	upsertPortImplementation(String userId, String serverName, PortImplementation portImplementation, String processGUID, String externalSourceName)	Create or update a Port Implementation with an associated SchemaType
GUIDResponse	upsertPortImplementation(String userId, String serverName, PortImplementationRequestBody portImplementationRequestBody)	Create or update the Port Implementation with a PortSchema relationship
GUIDResponse	upsertProcess(String userId, String serverName, Process process, String externalSourceName)	Create the process with ports, schema types and data flows
GUIDResponse	upsertProcess(String userId, String serverName, ProcessRequestBody processRequestBody)	Create or update the process with ports, schema types and data flows
VoidResponse	upsertProcessingState(String userId, String serverName, ProcessingState processingState, String externalSourceName)	Create or update the ProcessingState with provided map of critical elements and sync states
VoidResponse	upsertProcessingState(String userId, String serverName, ProcessingStateRequestBody processingStateRequestBody)	Create or update the ProcessingState with provided map of critical elements and sync states
String	upsertRelationalTable(String userId, String serverName, String databaseSchemaQualifiedName, RelationalTable relationalTable, String externalSourceName)	Create the Relational Table with Relational Columns and corresponding relationships
GUIDResponse	upsertRelationalTable(String userId, String serverName, RelationalTableRequestBody relationalTableRequestBody)	Create the Relational Table with Relational Columns and corresponding relationships
String	upsertSchemaType(String userId, String serverName, String portImplementationGUID, SchemaType schemaType, String externalSourceName)	Create or update a SchemaType
GUIDResponse	upsertSchemaType(String userId, String serverName, SchemaTypeRequestBody schemaTypeRequestBody)	Create the SchemaType with schema attributes and corresponding relationships
String	upsertTopic(String userId, String serverName, Topic topic, String externalSourceName)	Create or update the Topic with corresponding event types and relationship
GUIDResponse	upsertTopic(String userId, String serverName, TopicRequestBody topicRequestBody)	Create or update the Topic with corresponding event types and relationship

Methods inherited from class java.lang.Object

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

Field Details

DATABASE_SCHEMA_PARAMETER_NAME

public static final String DATABASE_SCHEMA_PARAMETER_NAME

See Also:

• Constant Field Values

DATABASE_PARAMETER_NAME

public static final String DATABASE_PARAMETER_NAME

See Also:

• Constant Field Values

RELATIONAL_TABLE_PARAMETER_NAME

public static final String RELATIONAL_TABLE_PARAMETER_NAME

See Also:

• Constant Field Values

SCHEMA

public static final String SCHEMA

See Also:

• Constant Field Values

SCHEMA_SUFFIX

public static final String SCHEMA_SUFFIX

See Also:

• Constant Field Values

EXTERNAL_SOURCE_NAME_PARAMETER_NAME

public static final String EXTERNAL_SOURCE_NAME_PARAMETER_NAME

See Also:

• Constant Field Values

UPSERT_METHOD_CALLS_FOR

public static final String UPSERT_METHOD_CALLS_FOR

See Also:

• Constant Field Values

TOPIC_PARAMETER_NAME

public static final String TOPIC_PARAMETER_NAME

See Also:

• Constant Field Values

PROCESSING_STATE

public static final String PROCESSING_STATE

See Also:

• Constant Field Values

Constructor Details

DataEngineRESTServices

public DataEngineRESTServices()

Method Details

createExternalDataEngine

public GUIDResponse createExternalDataEngine(String serverName,
 String userId,
 DataEngineRegistrationRequestBody requestBody)

Create the external data engine as engine entity

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the server

Returns:

the unique identifier (guid) of the created external data engine

getExternalDataEngine

public GUIDResponse getExternalDataEngine(String serverName,
 String userId,
 String qualifiedName)

Get the unique identifier from a external data engine qualified name

Parameters:

serverName - name of the service to route the request to

userId - identifier of calling user

qualifiedName - qualified name of the external data engine

Returns:

the unique identifier from an engine definition for an external data engine

deleteExternalDataEngine

public VoidResponse deleteExternalDataEngine(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the external data engine. Not yet implemented, it will throw FunctionNotSupportedException if used

Parameters:

serverName - name of the service to route the request to

userId - identifier of calling user

requestBody - properties of the external data engine

Returns:

void response

deleteExternalDataEngine

public void deleteExternalDataEngine(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException,
FunctionNotSupportedException

Delete the external data engine. Not yet implemented, it will throw FunctionNotSupportedException if used

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the schema type

qualifiedName - the qualified name of the schema type

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.

getEntityGUID

public Optional<String> getEntityGUID(String serverName,
 String userId,
 String qualifiedName,
 String typeName)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Get the unique identifier of an entity

Parameters:

serverName - name of the service to route the request to

userId - identifier of calling user

qualifiedName - qualified name of the port

typeName - the type name of the entity

Returns:

the unique identifier of the entity or empty optional

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getEntityDetails

public Optional<EntityDetail> getEntityDetails(String serverName,
 String userId,
 String qualifiedName,
 String typeName)
                                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Get the entity details of an entity

Parameters:

serverName - name of the service to route the request to

userId - identifier of calling user

qualifiedName - qualified name of the port

typeName - the type name of the entity

Returns:

the entity details of the entity or empty optional

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

upsertSchemaType

public GUIDResponse upsertSchemaType(String userId,
 String serverName,
 SchemaTypeRequestBody schemaTypeRequestBody)

Create the SchemaType with schema attributes and corresponding relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

schemaTypeRequestBody - properties of the schema type

Returns:

the unique identifier (guid) of the created schema type

deleteSchemaType

public VoidResponse deleteSchemaType(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the SchemaType with schema attributes and corresponding relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the schema type

Returns:

void response

deleteSchemaType

public void deleteSchemaType(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException,
FunctionNotSupportedException,
EntityNotDeletedException

Delete the SchemaType with schema attributes and corresponding relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the schema type

qualifiedName - the qualified name of the schema type

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.

EntityNotDeletedException - the entity could not be deleted

upsertPortImplementation

public GUIDResponse upsertPortImplementation(String userId,
 String serverName,
 PortImplementationRequestBody portImplementationRequestBody)

Create or update the Port Implementation with a PortSchema relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

portImplementationRequestBody - properties of the port

Returns:

the unique identifier (guid) of the created port

upsertPortAlias

public GUIDResponse upsertPortAlias(String userId,
 String serverName,
 PortAliasRequestBody portAliasRequestBody)

Create or update the Port Alias with a PortDelegation relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

portAliasRequestBody - properties of the port

Returns:

the unique identifier (guid) of the created port

deletePort

public VoidResponse deletePort(String userId,
 String serverName,
 DeleteRequestBody requestBody,
 String portType)

Delete the Port with the associated schema type and relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the port

portType - the type of the port

Returns:

void response

deletePort

public void deletePort(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 String portType,
 DeleteSemantic deleteSemantic)
                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException,
FunctionNotSupportedException,
EntityNotDeletedException

Delete the Port with the associated schema type and relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the port

qualifiedName - the qualified name of the port

portType - the port type

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.

EntityNotDeletedException - the entity could not be deleted

addProcessHierarchy

public GUIDResponse addProcessHierarchy(String userId,
 String serverName,
 ProcessHierarchyRequestBody processHierarchyRequestBody)

Add the provided ProcessHierarchy relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

processHierarchyRequestBody - properties of the process hierarchy

Returns:

the unique identifier (guid) of the child of the process hierarchy that was updated

upsertProcess

public GUIDResponse upsertProcess(String userId,
 String serverName,
 ProcessRequestBody processRequestBody)

Create or update the process with ports, schema types and data flows

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

processRequestBody - properties of the process

Returns:

a list unique identifiers (GUIDs) of the created/updated process

deleteProcess

public VoidResponse deleteProcess(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete a process, with the associated port implementations, port aliases and data flows

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

requestBody - properties of the processes

Returns:

void response

deleteProcess

public void deleteProcess(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException,
FunctionNotSupportedException,
EntityNotDeletedException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

FunctionNotSupportedException

EntityNotDeletedException

upsertPortAliasWithDelegation

public String upsertPortAliasWithDelegation(String userId,
 String serverName,
 PortAlias portAlias,
 String processGUID,
 String externalSourceName)
                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create or update a Port Alias with a PortDelegation relationship

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

portAlias - the port alias values

processGUID - the unique identifier of the process

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created port alias

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addProcessHierarchyToProcess

public String addProcessHierarchyToProcess(String userId,
 String serverName,
 ProcessHierarchy processHierarchy,
 String externalSourceName)
                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Add a a ProcessHierarchy relationship to the process

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

processHierarchy - the process hierarchy values

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the child of the process hierarchy that was updated

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

upsertPortImplementation

public String upsertPortImplementation(String userId,
 String serverName,
 PortImplementation portImplementation,
 String processGUID,
 String externalSourceName)
                                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
FunctionNotSupportedException

Create or update a Port Implementation with an associated SchemaType

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

portImplementation - the port implementation values

processGUID - the unique identifier of the process

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created port alias

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.

createExternalDataEngine

public String createExternalDataEngine(String userId,
 String serverName,
 Engine engine)
                                throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create the external data engine as engine entity

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

engine - the engine values

Returns:

he unique identifier (guid) of the created external data engine

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addDataFlows

public void addDataFlows(String userId,
 String serverName,
 List<DataFlow> dataFlows,
 FFDCResponseBase response,
 String externalSourceName)
                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create DataFlows relationships between schema attributes

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

dataFlows - the list of daa flows to be created

response - the response object that will capture the exceptions that might occur during parallel processing

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

addDataFlows

public VoidResponse addDataFlows(String userId,
 String serverName,
 DataFlowsRequestBody dataFlowsRequestBody)

Create DataFlow relationships between schema attributes

Parameters:

userId - the name of the calling user

serverName - ame of server instance to call

dataFlowsRequestBody - list of data flows

Returns:

void response

getInTopicConnection

public ConnectionResponse getInTopicConnection(String serverName,
 String userId)

Retrieve in topic connection details from the service instance hosting Data Engine access service

Parameters:

serverName - the name of server instance to call

userId - the name/identifier of the calling user

Returns:

OCF API ConnectionResponse object describing the details for the input topic connection used or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition

upsertSchemaType

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

Create or update a SchemaType

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

portImplementationGUID - the unique identifier of the port implementation

schemaType - the schema type values

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created schema type

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

upsertDatabase

public GUIDResponse upsertDatabase(String userId,
 String serverName,
 DatabaseRequestBody databaseRequestBody)

Create or update the Database with corresponding associated schema type and relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

databaseRequestBody - properties of the database

Returns:

the unique identifier (guid) of the created database

upsertDatabase

public String upsertDatabase(String userId,
 String serverName,
 Database database,
 String externalSourceName)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create or update the Database with corresponding associated schema type and relationship

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

database - the database values

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created database

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

upsertDatabaseSchema

public GUIDResponse upsertDatabaseSchema(String userId,
 String serverName,
 DatabaseSchemaRequestBody databaseSchemaRequestBody)

Create or update the Database Schema with corresponding related entities and classifications

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

databaseSchemaRequestBody - RequestBody properties of the database

Returns:

the unique identifier (guid) of the created database

upsertDatabaseSchema

public String upsertDatabaseSchema(String userId,
 String serverName,
 String databaseQualifiedName,
 DatabaseSchema databaseSchema,
 String externalSourceName)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create or update the DatabaseSchema with corresponding relationship to the database, if provided and not virtual

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

databaseQualifiedName - the database entity to which the database schema will be linked, if it exists

databaseSchema - the database schema values

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created database schema

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

deleteDatabase

public VoidResponse deleteDatabase(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the Database with all the associated relational tables

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the database

Returns:

void response

deleteDatabase

public void deleteDatabase(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
EntityNotDeletedException,
FunctionNotSupportedException

Delete the Database with all the associated relational tables

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the database

qualifiedName - the qualified name of the database

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.

EntityNotDeletedException - the entity could not be deleted

deleteDatabaseSchema

public VoidResponse deleteDatabaseSchema(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the DatabaseSchema with all the associated relational tables

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the database schema

Returns:

void response

deleteDatabaseSchema

public void deleteDatabaseSchema(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
EntityNotDeletedException,
FunctionNotSupportedException

Delete the DatabaseSchema with all the associated relational tables

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the database schema

qualifiedName - the qualified name of the database schema

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.

EntityNotDeletedException - the entity could not be deleted

upsertRelationalTable

public GUIDResponse upsertRelationalTable(String userId,
 String serverName,
 RelationalTableRequestBody relationalTableRequestBody)

Create the Relational Table with Relational Columns and corresponding relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

relationalTableRequestBody - properties of the relational table

Returns:

the unique identifier (guid) of the created relational table

upsertRelationalTable

public String upsertRelationalTable(String userId,
 String serverName,
 String databaseSchemaQualifiedName,
 RelationalTable relationalTable,
 String externalSourceName)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create the Relational Table with Relational Columns and corresponding relationships

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

databaseSchemaQualifiedName - the unique name of the database

relationalTable - the relational table values

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created relational table

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

deleteRelationalTable

public VoidResponse deleteRelationalTable(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the Relational Table with all the associated Relational Columns

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the relational table

Returns:

void response

deleteRelationalTable

public void deleteRelationalTable(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
EntityNotDeletedException,
FunctionNotSupportedException

Delete the Relational Table with all the associated Relational Columns

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the relational table

qualifiedName - the qualified name of the relational table

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.

EntityNotDeletedException - the entity could not be deleted

upsertDataFile

public GUIDResponse upsertDataFile(String serverName,
 String userId,
 DataFileRequestBody dataFileRequestBody)

Updates or inserts a DataFile or CSVFile, along with its schema, columns and folder hierarchy

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

dataFileRequestBody - properties of the data file

Returns:

the unique identifier (guid) of the created data file

upsertDataFile

public String upsertDataFile(String userId,
 String serverName,
 DataFile file,
 String externalSourceName)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Updates or inserts a DataFile or CSVFile, along with its schema, columns and folder hierarchy

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

file - the data file properties

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created data file

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

deleteDataFile

public VoidResponse deleteDataFile(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the Data File with all the associated Tabular Columns

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the data file

Returns:

void response

deleteDataFile

public void deleteDataFile(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                    throws InvalidParameterException,
PropertyServerException,
EntityNotDeletedException,
UserNotAuthorizedException,
FunctionNotSupportedException

Delete the Data File with all the associated Tabular Columns

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the data file

qualifiedName - the qualified name of the data file

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.

EntityNotDeletedException - the entity could not be deleted

deleteFolder

public VoidResponse deleteFolder(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the File Folder

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the folder

Returns:

void response

deleteFolder

public void deleteFolder(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
EntityNotDeletedException,
FunctionNotSupportedException

Delete the File Folder

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the folder

qualifiedName - the qualified name of the folder

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

EntityNotDeletedException - the entity could not be deleted

deleteConnection

public VoidResponse deleteConnection(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the Connection

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the connection

Returns:

void response

deleteConnection

public void deleteConnection(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                      throws InvalidParameterException,
PropertyServerException,
EntityNotDeletedException,
UserNotAuthorizedException,
FunctionNotSupportedException

Delete the Connection

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the connection

qualifiedName - the qualified name of the connection

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.

EntityNotDeletedException - the entity could not be deleted

deleteEndpoint

public VoidResponse deleteEndpoint(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the Endpoint

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the endpoint

Returns:

void response

deleteEndpoint

public void deleteEndpoint(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                    throws InvalidParameterException,
PropertyServerException,
EntityNotDeletedException,
UserNotAuthorizedException,
FunctionNotSupportedException

Delete the Endpoint

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the endpoint

qualifiedName - the qualified name of the endpoint

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.

EntityNotDeletedException - the entity could not be deleted

updateProcessStatus

public VoidResponse updateProcessStatus(String userId,
 String serverName,
 String processGUID,
 InstanceStatus instanceStatus,
 String externalSourceName)

upsertProcess

public GUIDResponse upsertProcess(String userId,
 String serverName,
 Process process,
 String externalSourceName)

Create the process with ports, schema types and data flows

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

process - properties of the process

externalSourceName - the name of the external source

Returns:

the unique identifier (guid) of the created process

find

public GUIDListResponse find(String userId,
 String serverName,
 FindRequestBody findRequestBody)

Performs a find for a DataEngine related object

Parameters:

userId - user id

serverName - server name

findRequestBody - contains find criteria

Returns:

a list of GUIDs

upsertTopic

public GUIDResponse upsertTopic(String userId,
 String serverName,
 TopicRequestBody topicRequestBody)

Create or update the Topic with corresponding event types and relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

topicRequestBody - properties of the topic

Returns:

the unique identifier (guid) of the created topic

upsertTopic

public String upsertTopic(String userId,
 String serverName,
 Topic topic,
 String externalSourceName)
                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create or update the Topic with corresponding event types and relationship

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

topic - the topic values

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created topic

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

deleteTopic

public VoidResponse deleteTopic(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the Topic with all the associated event types

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the topic

Returns:

void response

deleteTopic

public void deleteTopic(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
EntityNotDeletedException,
FunctionNotSupportedException

Delete the Topic with all the associated event types

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the topic

qualifiedName - the qualified name of the topic

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.

EntityNotDeletedException - the entity could not be deleted

upsertEventType

public GUIDResponse upsertEventType(String userId,
 String serverName,
 EventTypeRequestBody eventTypeRequestBody)

Create or update the EventType with corresponding associated event schema attributes

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

eventTypeRequestBody - properties of the event type

Returns:

the unique identifier (guid) of the created event type

getTopicGUID

public String getTopicGUID(String userId,
 String serverName,
 String topicQualifiedName,
 String methodName)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Get the unique identifier of a topic

Parameters:

serverName - name of the service to route the request to

userId - identifier of calling user

topicQualifiedName - qualified name of the topic

methodName - the name of the calling method

Returns:

the unique identifier of the entity

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

upsertEventType

public String upsertEventType(String userId,
 String serverName,
 EventType eventType,
 String topicGUID,
 String externalSourceName)
                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create or update the EventType with corresponding event schema attributes

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

eventType - the event type values

topicGUID - the unique identifier of the topic

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created event type

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

deleteEventType

public VoidResponse deleteEventType(String userId,
 String serverName,
 DeleteRequestBody requestBody)

Delete the EventType with all the associated event schema attributes

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the event type

Returns:

void response

deleteEventType

public void deleteEventType(String userId,
 String serverName,
 String externalSourceName,
 String guid,
 String qualifiedName,
 DeleteSemantic deleteSemantic)
                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
EntityNotDeletedException,
FunctionNotSupportedException

Delete the EventType with all the associated event schema attributes

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

externalSourceName - the unique name of the external source

guid - the unique identifier of the event type

qualifiedName - the qualified name of the event type

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.

EntityNotDeletedException - the entity could not be deleted

upsertProcessingState

public VoidResponse upsertProcessingState(String userId,
 String serverName,
 ProcessingStateRequestBody processingStateRequestBody)

Create or update the ProcessingState with provided map of critical elements and sync states

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

processingStateRequestBody - map of critical elements and sync states

Returns:

void response

getProcessingState

public PropertiesResponse getProcessingState(String userId,
 String serverName,
 String externalSourceName)

upsertProcessingState

public VoidResponse upsertProcessingState(String userId,
 String serverName,
 ProcessingState processingState,
 String externalSourceName)

Create or update the ProcessingState with provided map of critical elements and sync states

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

processingState - map of critical elements and sync states

externalSourceName - the unique name of the external source

Returns:

void response