Package org.odpi.openmetadata.accessservices.datamanager.server.spring

Class DataManagerOMASResource

java.lang.Object
org.odpi.openmetadata.accessservices.datamanager.server.spring.DataManagerOMASResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/data-manager/users/{userId}") public class DataManagerOMASResource extends Object
Server-side REST API support for data manager independent REST endpoints

  • Constructor Details

    • DataManagerOMASResource

      public DataManagerOMASResource()
      Instantiates a new Data Manager OMAS resource.

  • Method Details

    • getOutTopicConnection

      @GetMapping(path="/topics/out-topic-connection/{callerId}") public OCFConnectionResponse getOutTopicConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String callerId)
      Return the connection object for the Data Manager OMAS's out topic.
      Parameters:
      serverName - name of the server to route the request to
      userId - identifier of calling user
      callerId - unique identifier of the caller
      Returns:
      connection object for the out topic 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.

    • createFileSystemInCatalog

      @PostMapping(path="/metadata-sources/filesystems") public GUIDResponse createFileSystemInCatalog(@PathVariable String serverName, @PathVariable String userId, @RequestBody FileSystemRequestBody requestBody)
      Files live on a file system. This method creates a top level software server capability for a filesystem.
      Parameters:
      serverName - name of calling server
      userId - calling user
      requestBody - properties of the file system
      Returns:
      unique identifier for the file system or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • createFileManagerInCatalog

      @PostMapping(path="/metadata-sources/file-managers") public GUIDResponse createFileManagerInCatalog(@PathVariable String serverName, @PathVariable String userId, @RequestBody FileManagerRequestBody requestBody)
      Files can be owned by a file manager. This method creates a top level software server capability for a file manager.
      Parameters:
      serverName - name of calling server
      userId - calling user
      requestBody - properties of the file manager
      Returns:
      unique identifier for the file system or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • createDatabaseManager

      @PostMapping(path="/metadata-sources/database-managers") public GUIDResponse createDatabaseManager(@PathVariable String serverName, @PathVariable String userId, @RequestBody DatabaseManagerRequestBody requestBody)
      Create information about the database manager (DBMS) that manages database schemas.
      Parameters:
      serverName - name of the server to route the request to.
      userId - calling user
      requestBody - description of the software server capability (specify qualified name at a minimum)
      Returns:
      unique identifier of the database manager's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • createAPIManager

      @PostMapping(path="/metadata-sources/api-managers") public GUIDResponse createAPIManager(@PathVariable String serverName, @PathVariable String userId, @RequestBody APIManagerRequestBody requestBody)
      Create information about the API manager that manages APIs.
      Parameters:
      serverName - name of the server to route the request to.
      userId - calling user
      requestBody - description of the software server capability (specify qualified name at a minimum)
      Returns:
      unique identifier of the database manager's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • createEventBroker

      @PostMapping(path="/metadata-sources/event-brokers") public GUIDResponse createEventBroker(@PathVariable String serverName, @PathVariable String userId, @RequestBody EventBrokerRequestBody requestBody)
      Create information about the event broker that manages topics.
      Parameters:
      serverName - name of the server to route the request to.
      userId - calling user
      requestBody - description of the software server capability (specify qualified name at a minimum)
      Returns:
      unique identifier of the database manager's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • createApplication

      @PostMapping(path="/metadata-sources/applications") public GUIDResponse createApplication(@PathVariable String serverName, @PathVariable String userId, @RequestBody ApplicationRequestBody requestBody)
      Create information about the applications tha manage business processes and interactions with users.
      Parameters:
      serverName - name of the server to route the request to.
      userId - calling user
      requestBody - description of the software server capability (specify qualified name at a minimum)
      Returns:
      unique identifier of the database manager's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • createDataProcessingEngine

      @PostMapping(path="/metadata-sources/data-processing-engines") public GUIDResponse createDataProcessingEngine(@PathVariable String serverName, @PathVariable String userId, @RequestBody DataProcessingEngineRequestBody requestBody)
      Create information about a data processing engine such as a reporting engine.
      Parameters:
      serverName - name of the server to route the request to.
      userId - calling user
      requestBody - description of the software server capability (specify qualified name at a minimum)
      Returns:
      unique identifier of the database manager's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • getMetadataSourceGUID

      @PostMapping(path="metadata-sources/by-name") public GUIDResponse getMetadataSourceGUID(@PathVariable String serverName, @PathVariable String userId, @RequestBody NameRequestBody requestBody)
      Retrieve the unique identifier of the software server capability representing a metadata source.
      Parameters:
      serverName - name of the server to route the request to.
      userId - calling user
      requestBody - unique name of the integration daemon
      Returns:
      unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server