Class DataEngineRESTServices
java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.server.service.DataEngineRESTServices
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.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDataFlows
(String userId, String serverName, List<DataFlow> dataFlows, FFDCResponseBase response, String externalSourceName) Create DataFlows relationships between schema attributesaddDataFlows
(String userId, String serverName, DataFlowsRequestBody dataFlowsRequestBody) Create DataFlow relationships between schema attributesaddProcessHierarchy
(String userId, String serverName, ProcessHierarchyRequestBody processHierarchyRequestBody) Add the provided ProcessHierarchy relationshipaddProcessHierarchyToProcess
(String userId, String serverName, ProcessHierarchy processHierarchy, String externalSourceName) Add a a ProcessHierarchy relationship to the processcreateExternalDataEngine
(String userId, String serverName, Engine engine) Create the external data engine as engine entitycreateExternalDataEngine
(String serverName, String userId, DataEngineRegistrationRequestBody requestBody) Create the external data engine as engine entityvoid
deleteConnection
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the ConnectiondeleteConnection
(String userId, String serverName, DeleteRequestBody requestBody) Delete the Connectionvoid
deleteDatabase
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the Database with all the associated relational tablesdeleteDatabase
(String userId, String serverName, DeleteRequestBody requestBody) Delete the Database with all the associated relational tablesvoid
deleteDatabaseSchema
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the DatabaseSchema with all the associated relational tablesdeleteDatabaseSchema
(String userId, String serverName, DeleteRequestBody requestBody) Delete the DatabaseSchema with all the associated relational tablesvoid
deleteDataFile
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the Data File with all the associated Tabular ColumnsdeleteDataFile
(String userId, String serverName, DeleteRequestBody requestBody) Delete the Data File with all the associated Tabular Columnsvoid
deleteEndpoint
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the EndpointdeleteEndpoint
(String userId, String serverName, DeleteRequestBody requestBody) Delete the Endpointvoid
deleteEventType
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the EventType with all the associated event schema attributesdeleteEventType
(String userId, String serverName, DeleteRequestBody requestBody) Delete the EventType with all the associated event schema attributesvoid
deleteExternalDataEngine
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the external data engine.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 FolderdeleteFolder
(String userId, String serverName, DeleteRequestBody requestBody) Delete the File Foldervoid
deletePort
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, String portType, DeleteSemantic deleteSemantic) Delete the Port with the associated schema type and relationshipsdeletePort
(String userId, String serverName, DeleteRequestBody requestBody, String portType) Delete the Port with the associated schema type and relationshipsvoid
deleteProcess
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete a process, with the associated port implementations and data flowsdeleteProcess
(String userId, String serverName, DeleteRequestBody requestBody) Delete a process, with the associated port implementations and data flowsvoid
deleteRelationalTable
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the Relational Table with all the associated Relational ColumnsdeleteRelationalTable
(String userId, String serverName, DeleteRequestBody requestBody) Delete the Relational Table with all the associated Relational Columnsvoid
deleteSchemaType
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the SchemaType with schema attributes and corresponding relationshipsdeleteSchemaType
(String userId, String serverName, DeleteRequestBody requestBody) Delete the SchemaType with schema attributes and corresponding relationshipsvoid
deleteTopic
(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic) Delete the Topic with all the associated event typesdeleteTopic
(String userId, String serverName, DeleteRequestBody requestBody) Delete the Topic with all the associated event typesfind
(String userId, String serverName, FindRequestBody findRequestBody) Performs a find for a DataEngine related objectgetEntityDetails
(String serverName, String userId, String qualifiedName, String typeName) Get the entity details of an entitygetEntityGUID
(String serverName, String userId, String qualifiedName, String typeName) Get the unique identifier of an entitygetExternalDataEngine
(String serverName, String userId, String qualifiedName) Get the unique identifier from a external data engine qualified namegetInTopicConnection
(String serverName, String userId) Retrieve in topic connection details from the service instance hosting Data Engine access servicegetProcessingState
(String userId, String serverName, String externalSourceName) getTopicGUID
(String userId, String serverName, String topicQualifiedName, String methodName) Get the unique identifier of a topicupdateProcessStatus
(String userId, String serverName, String processGUID, InstanceStatus instanceStatus, String externalSourceName) Update the process statusupsertDatabase
(String userId, String serverName, Database database, String externalSourceName) Create or update the Database with corresponding associated schema type and relationshipupsertDatabase
(String userId, String serverName, DatabaseRequestBody databaseRequestBody) Create or update the Database with corresponding associated schema type and relationshipupsertDatabaseSchema
(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 virtualupsertDatabaseSchema
(String userId, String serverName, DatabaseSchemaRequestBody databaseSchemaRequestBody) Create or update the Database Schema with corresponding related entities and classificationsupsertDataFile
(String userId, String serverName, DataFile file, String externalSourceName) Updates or inserts a DataFile or CSVFile, along with its schema, columns and folder hierarchyupsertDataFile
(String serverName, String userId, DataFileRequestBody dataFileRequestBody) Updates or inserts a DataFile or CSVFile, along with its schema, columns and folder hierarchyupsertEventType
(String userId, String serverName, EventType eventType, String topicGUID, String externalSourceName) Create or update the EventType with corresponding event schema attributesupsertEventType
(String userId, String serverName, EventTypeRequestBody eventTypeRequestBody) Create or update the EventType with corresponding associated event schema attributesupsertPortImplementation
(String userId, String serverName, PortImplementation portImplementation, String processGUID, String externalSourceName) Create or update a Port Implementation with an associated SchemaTypeupsertPortImplementation
(String userId, String serverName, PortImplementationRequestBody portImplementationRequestBody) Create or update the Port Implementation with a PortSchema relationshipupsertProcess
(String userId, String serverName, Process process, String externalSourceName) Create the process with ports, schema types and data flowsupsertProcess
(String userId, String serverName, ProcessRequestBody processRequestBody) Create or update the process with ports, schema types and data flowsupsertProcessingState
(String userId, String serverName, ProcessingState processingState, String externalSourceName) Create or update the ProcessingState with provided map of critical elements and sync statesupsertProcessingState
(String userId, String serverName, ProcessingStateRequestBody processingStateRequestBody) Create or update the ProcessingState with provided map of critical elements and sync statesupsertRelationalTable
(String userId, String serverName, String databaseSchemaQualifiedName, RelationalTable relationalTable, String externalSourceName) Create the Relational Table with Relational Columns and corresponding relationshipsupsertRelationalTable
(String userId, String serverName, RelationalTableRequestBody relationalTableRequestBody) Create the Relational Table with Relational Columns and corresponding relationshipsupsertSchemaType
(String userId, String serverName, String portImplementationGUID, SchemaType schemaType, String externalSourceName) Create or update a SchemaTypeupsertSchemaType
(String userId, String serverName, SchemaTypeRequestBody schemaTypeRequestBody) Create the SchemaType with schema attributes and corresponding relationshipsupsertTopic
(String userId, String serverName, Topic topic, String externalSourceName) Create or update the Topic with corresponding event types and relationshipupsertTopic
(String userId, String serverName, TopicRequestBody topicRequestBody) Create or update the Topic with corresponding event types and relationship
-
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 calluserId
- the name of the calling userrequestBody
- properties of the server- Returns:
- the unique identifier (guid) of the created external data engine
-
getExternalDataEngine
Get the unique identifier from a external data engine qualified name- Parameters:
serverName
- name of the service to route the request touserId
- identifier of calling userqualifiedName
- 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 touserId
- identifier of calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the schema typequalifiedName
- the qualified name of the schema typedeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 touserId
- identifier of calling userqualifiedName
- qualified name of the porttypeName
- the type name of the entity- Returns:
- the unique identifier of the entity or empty optional
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 touserId
- identifier of calling userqualifiedName
- qualified name of the porttypeName
- the type name of the entity- Returns:
- the entity details of the entity or empty optional
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 calluserId
- the name of the calling userschemaTypeRequestBody
- 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 calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the schema typequalifiedName
- the qualified name of the schema typedeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 calluserId
- the name of the calling userportImplementationRequestBody
- 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 calluserId
- the name of the calling userrequestBody
- properties of the portportType
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the portqualifiedName
- the qualified name of the portportType
- the port typedeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 calluserId
- the name of the calling userprocessHierarchyRequestBody
- 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 userserverName
- name of server instance to callprocessRequestBody
- properties of the process- Returns:
- a list unique identifiers (GUIDs) of the created/updated process
-
deleteProcess
Delete a process, with the associated port implementations and data flows- Parameters:
userId
- the name of the calling userserverName
- name of server instance to callrequestBody
- 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 Delete a process, with the associated port implementations and data flows- Parameters:
serverName
- name of server instance to calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the processqualifiedName
- the qualified name of the processdeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- the repository does not support this call.EntityNotDeletedException
- the entity could not be deleted
-
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 userserverName
- name of server instance to callprocessHierarchy
- the process hierarchy valuesexternalSourceName
- 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 invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userserverName
- name of server instance to callportImplementation
- the port implementation valuesprocessGUID
- the unique identifier of the processexternalSourceName
- the unique name of the external source- Returns:
- the unique identifier (guid) of the created port implementation
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 userserverName
- name of server instance to callengine
- the engine values- Returns:
- he unique identifier (guid) of the created external data engine
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userserverName
- name of server instance to calldataFlows
- the list of daa flows to be createdresponse
- the response object that will capture the exceptions that might occur during parallel processingexternalSourceName
- the unique name of the external source- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userserverName
- ame of server instance to calldataFlowsRequestBody
- list of data flows- Returns:
- void response
-
getInTopicConnection
Retrieve in topic connection details from the service instance hosting Data Engine access service- Parameters:
serverName
- the name of server instance to calluserId
- 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 userserverName
- name of server instance to callportImplementationGUID
- the unique identifier of the port implementationschemaType
- the schema type valuesexternalSourceName
- the unique name of the external source- Returns:
- the unique identifier (guid) of the created schema type
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 calluserId
- the name of the calling userdatabaseRequestBody
- 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 userserverName
- name of server instance to calldatabase
- the database valuesexternalSourceName
- the unique name of the external source- Returns:
- the unique identifier (guid) of the created database
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 calluserId
- the name of the calling userdatabaseSchemaRequestBody
- 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 userserverName
- name of server instance to calldatabaseQualifiedName
- the database entity to which the database schema will be linked, if it existsdatabaseSchema
- the database schema valuesexternalSourceName
- the unique name of the external source- Returns:
- the unique identifier (guid) of the created database schema
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
deleteDatabase
Delete the Database with all the associated relational tables- Parameters:
serverName
- name of server instance to calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the databasequalifiedName
- the qualified name of the databasedeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the database schemaqualifiedName
- the qualified name of the database schemadeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 calluserId
- the name of the calling userrelationalTableRequestBody
- 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 userserverName
- name of server instance to calldatabaseSchemaQualifiedName
- the unique name of the databaserelationalTable
- the relational table valuesexternalSourceName
- the unique name of the external source- Returns:
- the unique identifier (guid) of the created relational table
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the relational tablequalifiedName
- the qualified name of the relational tabledeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 userserverName
- name of server instance to calldataFileRequestBody
- 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 userserverName
- name of server instance to callfile
- the data file propertiesexternalSourceName
- the unique name of the external source- Returns:
- the unique identifier (guid) of the created data file
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
deleteDataFile
Delete the Data File with all the associated Tabular Columns- Parameters:
serverName
- name of server instance to calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the data filequalifiedName
- the qualified name of the data filedeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- the repository does not support this call.EntityNotDeletedException
- the entity could not be deleted
-
deleteFolder
Delete the File Folder- Parameters:
serverName
- name of server instance to calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the folderqualifiedName
- the qualified name of the folderdeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- the repository does not support this callEntityNotDeletedException
- 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 calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the connectionqualifiedName
- the qualified name of the connectiondeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- the repository does not support this call.EntityNotDeletedException
- the entity could not be deleted
-
deleteEndpoint
Delete the Endpoint- Parameters:
serverName
- name of server instance to calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the endpointqualifiedName
- the qualified name of the endpointdeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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) Update the process status- Parameters:
userId
- the name of the calling userserverName
- name of server instance to callprocessGUID
- the GUID of the processinstanceStatus
- theInstanceStatus
externalSourceName
- the name of the external source- Returns:
- void response
-
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 calluserId
- the name of the calling userprocess
- properties of the processexternalSourceName
- the name of the external source- Returns:
- the unique identifier (guid) of the created process
-
find
Performs a find for a DataEngine related object- Parameters:
userId
- user idserverName
- server namefindRequestBody
- 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 calluserId
- the name of the calling usertopicRequestBody
- 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 userserverName
- name of server instance to calltopic
- the topic valuesexternalSourceName
- the unique name of the external source- Returns:
- the unique identifier (guid) of the created topic
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
deleteTopic
Delete the Topic with all the associated event types- Parameters:
serverName
- name of server instance to calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the topicqualifiedName
- the qualified name of the topicdeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 calluserId
- the name of the calling usereventTypeRequestBody
- 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 touserId
- identifier of calling usertopicQualifiedName
- qualified name of the topicmethodName
- the name of the calling method- Returns:
- the unique identifier of the entity
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userserverName
- name of server instance to calleventType
- the event type valuestopicGUID
- the unique identifier of the topicexternalSourceName
- the unique name of the external source- Returns:
- the unique identifier (guid) of the created event type
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 calluserId
- the name of the calling userrequestBody
- 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 calluserId
- the name of the calling userexternalSourceName
- the unique name of the external sourceguid
- the unique identifier of the event typequalifiedName
- the qualified name of the event typedeleteSemantic
- the delete semantic- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property serverFunctionNotSupportedException
- 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 calluserId
- the name of the calling userprocessingStateRequestBody
- 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 calluserId
- the name of the calling userprocessingState
- map of critical elements and sync statesexternalSourceName
- the unique name of the external source- Returns:
- void response
-