Interface DataEngineClient
- All Known Implementing Classes:
DataEngineEventClient
,DataEngineRESTClient
,DataEngineRESTConfigurationClient
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 TypeMethodDescriptionvoid
addDataFlows
(String userId, List<DataFlow> dataFlows) Add data flow relationships between entitiesaddProcessHierarchy
(String userId, ProcessHierarchy processHierarchy) Add a ProcessHierarchy relationship to a processcreateExternalDataEngine
(String userId, Engine engine) Create or update the engine entitycreateOrUpdatePortImplementation
(String userId, PortImplementation portImplementation, String processQualifiedName) Create or update the port implementation entity,with the corresponding schema type and port schema relationship.createOrUpdateProcess
(String userId, Process process) Create or update the process, with all the ports, schema types and corresponding relationships including the process hierarchy relationship.createOrUpdateSchemaType
(String userId, SchemaType schemaType) Create or update the schema type entity, with the corresponding schema attributes and relationshipsvoid
deleteConnection
(String userId, String qualifiedName, String guid) Delete the connectionvoid
deleteDatabase
(String userId, String qualifiedName, String guid) Delete the databasevoid
deleteDatabaseSchema
(String userId, String qualifiedName, String guid) Delete the database schemavoid
deleteDataFile
(String userId, String qualifiedName, String guid) Delete the data filevoid
deleteEndpoint
(String userId, String qualifiedName, String guid) Delete the endpointvoid
deleteEventType
(String userId, String qualifiedName, String guid) Delete the event typevoid
deleteExternalDataEngine
(String userId, String qualifiedName, String guid) Delete the external data enginevoid
deleteFolder
(String userId, String qualifiedName, String guid) Delete the foldervoid
deletePortImplementation
(String userId, String qualifiedName, String guid) Delete the port implementationvoid
deleteProcess
(String userId, String qualifiedName, String guid) Delete a processvoid
deleteRelationalTable
(String userId, String qualifiedName, String guid) Delete the relational tablevoid
deleteSchemaType
(String userId, String qualifiedName, String guid) Delete the schema typevoid
deleteTopic
(String userId, String qualifiedName, String guid) Delete the topicfind
(String userId, FindRequestBody findRequestBody) Find an entityReturns the name of the source system using data engine clientgetProcessingState
(String userId) Get the engine's processing state classification's propertiesvoid
setExternalSourceName
(String externalSourceName) Sets external source system name using the data engine clientupsertDatabase
(String userId, Database database) Create or update the database entityupsertDatabaseSchema
(String userId, DatabaseSchema databaseSchema, String databaseQualifiedName) Create or update the database schema entityupsertDataFile
(String userId, DataFile dataFile) Create or update the data file entityupsertEventType
(String userId, EventType eventType, String topicQualifiedName) Create or update the event type entityvoid
upsertProcessingState
(String userId, Map<String, Long> properties) Create or update the engine's processing state classification with the provided propertiesupsertRelationalTable
(String userId, RelationalTable relationalTable, String databaseSchemaQualifiedName) Create or update the relational table entityupsertTopic
(String userId, Topic topic) Create or update the topic entity
-
Method Details
-
createOrUpdateProcess
String createOrUpdateProcess(String userId, Process process) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Create or update the process, with all the ports, schema types and corresponding relationships including the process hierarchy relationship.- Parameters:
userId
- the name of the calling userprocess
- the process- Returns:
- unique identifier of the process in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteProcess
void deleteProcess(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete a process- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the process to be deletedguid
- the unique identifier of the process to be deleted- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
createExternalDataEngine
String createExternalDataEngine(String userId, Engine engine) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Create or update the engine entity- Parameters:
userId
- the name of the calling userengine
- the engine bean- Returns:
- unique identifier of the server in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteExternalDataEngine
void deleteExternalDataEngine(String userId, String qualifiedName, String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Delete the external data engine- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the external data engineguid
- the unique identifier of the external data engine- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
createOrUpdateSchemaType
String createOrUpdateSchemaType(String userId, SchemaType schemaType) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Create or update the schema type entity, with the corresponding schema attributes and relationships- Parameters:
userId
- the name of the calling userschemaType
- the schema type bean- Returns:
- unique identifier of the schema type in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteSchemaType
void deleteSchemaType(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the schema type- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the schema typeguid
- the unique identifier of the schema type- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
createOrUpdatePortImplementation
String createOrUpdatePortImplementation(String userId, PortImplementation portImplementation, String processQualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Create or update the port implementation entity,with the corresponding schema type and port schema relationship. It attaches the port implementation to the provided process- Parameters:
userId
- the name of the calling userportImplementation
- the port implementation beanprocessQualifiedName
- the process qualified name- Returns:
- unique identifier of the port implementation in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
deletePortImplementation
void deletePortImplementation(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the port implementation- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of port implementationguid
- the unique identifier of the port implementation- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
addProcessHierarchy
String addProcessHierarchy(String userId, ProcessHierarchy processHierarchy) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Add a ProcessHierarchy relationship to a process- Parameters:
userId
- the name of the calling userprocessHierarchy
- the process hierarchy bean- Returns:
- the unique identifier (guid) of the child of the process hierarchy that was updated
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
addDataFlows
void addDataFlows(String userId, List<DataFlow> dataFlows) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Add data flow relationships between entities- Parameters:
userId
- the name of the calling userdataFlows
- list of data flows- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
setExternalSourceName
Sets external source system name using the data engine client- Parameters:
externalSourceName
- Source system name
-
getExternalSourceName
String getExternalSourceName()Returns the name of the source system using data engine client- Returns:
- Source system name
-
upsertDatabase
String upsertDatabase(String userId, Database database) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Create or update the database entity- Parameters:
userId
- the name of the calling userdatabase
- the database bean- Returns:
- unique identifier of database in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
upsertDatabaseSchema
String upsertDatabaseSchema(String userId, DatabaseSchema databaseSchema, String databaseQualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Create or update the database schema entity- Parameters:
userId
- the name of the calling userdatabaseSchema
- the database schema beandatabaseQualifiedName
- the qualified name of the database, in case it is known- Returns:
- unique identifier of database schema in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
upsertRelationalTable
String upsertRelationalTable(String userId, RelationalTable relationalTable, String databaseSchemaQualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Create or update the relational table entity- Parameters:
userId
- the name of the calling userrelationalTable
- the relational table beandatabaseSchemaQualifiedName
- the qualified name of the database schema to which it will be related- Returns:
- unique identifier of the relational table in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
upsertDataFile
String upsertDataFile(String userId, DataFile dataFile) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Create or update the data file entity- Parameters:
userId
- the name of the calling userdataFile
- the data file bean- Returns:
- unique identifier of the relational table in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
deleteDatabase
void deleteDatabase(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the database- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the databaseguid
- the unique identifier of the database- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteDatabaseSchema
void deleteDatabaseSchema(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the database schema- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the database schemaguid
- the unique identifier of the database schema- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteRelationalTable
void deleteRelationalTable(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the relational table- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the relational tableguid
- the unique identifier of the relational table- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteDataFile
void deleteDataFile(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the data file- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the data fileguid
- the unique identifier of the data file- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteFolder
void deleteFolder(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the folder- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the data fileguid
- the unique identifier of the folder- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteConnection
void deleteConnection(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the connection- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the connectionguid
- the unique identifier of the connection- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteEndpoint
void deleteEndpoint(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the endpoint- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the endpointguid
- the unique identifier of the endpoint- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
find
GUIDListResponse find(String userId, FindRequestBody findRequestBody) throws ConnectorCheckedException, InvalidParameterException, UserNotAuthorizedException, PropertyServerException, FunctionNotSupportedException Find an entity- Parameters:
userId
- the name of the calling userfindRequestBody
- request body- Returns:
- list of found entities
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)FunctionNotSupportedException
- this request is not supported in the target repositories
-
upsertTopic
String upsertTopic(String userId, Topic topic) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Create or update the topic entity- Parameters:
userId
- the name of the calling usertopic
- the topic bean- Returns:
- unique identifier of topic in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
upsertEventType
String upsertEventType(String userId, EventType eventType, String topicQualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException, ConnectorCheckedException Create or update the event type entity- Parameters:
userId
- the name of the calling usereventType
- the event type beantopicQualifiedName
- the qualified name of the topic- Returns:
- unique identifier of event type in the repository
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- internal problem with the connector
-
deleteTopic
void deleteTopic(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the topic- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the topicguid
- the unique identifier of the topic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
deleteEventType
void deleteEventType(String userId, String qualifiedName, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ConnectorCheckedException Delete the event type- Parameters:
userId
- the name of the calling userqualifiedName
- the qualified name of the event typeguid
- the unique identifier of the event type- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverConnectorCheckedException
- problem with the underlying connector (if used)
-
upsertProcessingState
void upsertProcessingState(String userId, Map<String, Long> properties) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException, ConnectorCheckedExceptionCreate or update the engine's processing state classification with the provided properties- Parameters:
userId
- the name of the calling userproperties
- properties of the processing state- Throws:
PropertyServerException
InvalidParameterException
UserNotAuthorizedException
ConnectorCheckedException
-
getProcessingState
Get the engine's processing state classification's properties- Parameters:
userId
- the name of the calling user- Throws:
PropertyServerException
-