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

Class DisplayApplicationRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.datamanager.server.DisplayApplicationRESTServices
public class DisplayApplicationRESTServices extends Object
DisplayApplicationRESTServices is the server-side implementation of the Data Manager OMAS's support for forms. It matches the DisplayApplicationClient.

  • Constructor Details

    • DisplayApplicationRESTServices

      public DisplayApplicationRESTServices()
      Default constructor

  • Method Details

    • createForm

      public GUIDResponse createForm(String serverName, String userId, boolean applicationIsHome, FormRequestBody requestBody)
      Create a new metadata element to represent a form.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      applicationIsHome - should the form be marked as owned by the application so others can not update?
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createFormFromTemplate

      public GUIDResponse createFormFromTemplate(String serverName, String userId, String templateGUID, boolean applicationIsHome, TemplateRequestBody requestBody)
      Create a new metadata element to represent a form using an existing metadata element as a template.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      applicationIsHome - should the form be marked as owned by the application so others can not update?
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateForm

      public VoidResponse updateForm(String serverName, String userId, String formGUID, boolean isMergeUpdate, FormRequestBody requestBody)
      Update the metadata element representing a form.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      formGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with the existing properties of overlay them?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • publishForm

      public VoidResponse publishForm(String serverName, String userId, String formGUID, NullRequestBody nullRequestBody)
      Update the zones for the form asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      formGUID - unique identifier of the metadata element to publish
      nullRequestBody - empty request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • withdrawForm

      public VoidResponse withdrawForm(String serverName, String userId, String formGUID, NullRequestBody nullRequestBody)
      Update the zones for the form asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the form is first created).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      formGUID - unique identifier of the metadata element to withdraw
      nullRequestBody - empty request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeForm

      public VoidResponse removeForm(String serverName, String userId, String formGUID, String qualifiedName, MetadataSourceRequestBody requestBody)
      Remove the metadata element representing a form.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      formGUID - unique identifier of the metadata element to remove
      qualifiedName - unique name of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findForms

      public FormsResponse findForms(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of form metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getFormsByName

      public FormsResponse getFormsByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of form metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getFormsForApplication

      public FormsResponse getFormsForApplication(String serverName, String userId, String applicationGUID, String applicationName, int startFrom, int pageSize)
      Retrieve the list of forms created by this caller.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      applicationGUID - unique identifier of software server capability representing the application
      applicationName - unique name of software server capability representing the application
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getFormByGUID

      public FormResponse getFormByGUID(String serverName, String userId, String guid)
      Retrieve the form metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createReport

      public GUIDResponse createReport(String serverName, String userId, boolean applicationIsHome, ReportRequestBody requestBody)
      Create a new metadata element to represent a report.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      applicationIsHome - should the report be marked as owned by the application so others can not update?
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createReportFromTemplate

      public GUIDResponse createReportFromTemplate(String serverName, String userId, String templateGUID, boolean applicationIsHome, TemplateRequestBody requestBody)
      Create a new metadata element to represent a report using an existing metadata element as a template.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      applicationIsHome - should the report be marked as owned by the application so others can not update?
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateReport

      public VoidResponse updateReport(String serverName, String userId, String reportGUID, boolean isMergeUpdate, ReportRequestBody requestBody)
      Update the metadata element representing a report.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      reportGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with the existing properties of overlay them?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • publishReport

      public VoidResponse publishReport(String serverName, String userId, String reportGUID, NullRequestBody nullRequestBody)
      Update the zones for the report asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      reportGUID - unique identifier of the metadata element to publish
      nullRequestBody - empty request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • withdrawReport

      public VoidResponse withdrawReport(String serverName, String userId, String reportGUID, NullRequestBody nullRequestBody)
      Update the zones for the report asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the report is first created).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      reportGUID - unique identifier of the metadata element to withdraw
      nullRequestBody - empty request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeReport

      public VoidResponse removeReport(String serverName, String userId, String reportGUID, String qualifiedName, MetadataSourceRequestBody requestBody)
      Remove the metadata element representing a report.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      reportGUID - unique identifier of the metadata element to remove
      qualifiedName - unique name of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findReports

      public ReportsResponse findReports(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of report metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getReportsByName

      public ReportsResponse getReportsByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of report metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getReportsForApplication

      public ReportsResponse getReportsForApplication(String serverName, String userId, String applicationGUID, String applicationName, int startFrom, int pageSize)
      Retrieve the list of reports created by this caller.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      applicationGUID - unique identifier of software server capability representing the application
      applicationName - unique name of software server capability representing the application
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getReportByGUID

      public ReportResponse getReportByGUID(String serverName, String userId, String guid)
      Retrieve the report metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createQuery

      public GUIDResponse createQuery(String serverName, String userId, boolean applicationIsHome, QueryRequestBody requestBody)
      Create a new metadata element to represent a query.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      applicationIsHome - should the query be marked as owned by the application so others can not update?
      requestBody - properties to store
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createQueryFromTemplate

      public GUIDResponse createQueryFromTemplate(String serverName, String userId, String templateGUID, boolean applicationIsHome, TemplateRequestBody requestBody)
      Create a new metadata element to represent a query using an existing metadata element as a template.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      applicationIsHome - should the query be marked as owned by the application so others can not update?
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateQuery

      public VoidResponse updateQuery(String serverName, String userId, String queryGUID, boolean isMergeUpdate, QueryRequestBody requestBody)
      Update the metadata element representing a query.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      queryGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with the existing properties of overlay them?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • publishQuery

      public VoidResponse publishQuery(String serverName, String userId, String queryGUID, NullRequestBody nullRequestBody)
      Update the zones for the query asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      queryGUID - unique identifier of the metadata element to publish
      nullRequestBody - empty request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • withdrawQuery

      public VoidResponse withdrawQuery(String serverName, String userId, String queryGUID, NullRequestBody nullRequestBody)
      Update the zones for the query asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the query is first created).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      queryGUID - unique identifier of the metadata element to withdraw
      nullRequestBody - empty request body
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeQuery

      public VoidResponse removeQuery(String serverName, String userId, String queryGUID, String qualifiedName, MetadataSourceRequestBody requestBody)
      Remove the metadata element representing a query.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      queryGUID - unique identifier of the metadata element to remove
      qualifiedName - unique name of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findQueries

      public QueriesResponse findQueries(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of query metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getQueriesByName

      public QueriesResponse getQueriesByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of query metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getQueriesForApplication

      public QueriesResponse getQueriesForApplication(String serverName, String userId, String applicationGUID, String applicationName, int startFrom, int pageSize)
      Retrieve the list of queries created by this caller.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      applicationGUID - unique identifier of software server capability representing the application
      applicationName - unique name of software server capability representing the application
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getQueryByGUID

      public QueryResponse getQueryByGUID(String serverName, String userId, String guid)
      Retrieve the query metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createDataContainer

      public GUIDResponse createDataContainer(String serverName, String userId, String parentGUID, boolean applicationIsHome, DataContainerRequestBody requestBody)
      Create a new metadata element to represent a data field.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      applicationIsHome - should the data field be marked as owned by the event broker so others can not update?
      parentGUID - unique identifier of the parent element where the schema is located
      requestBody - properties about the data field
      Returns:
      unique identifier of the new data field or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createDataContainerFromTemplate

      public GUIDResponse createDataContainerFromTemplate(String serverName, String userId, String templateGUID, String parentGUID, boolean applicationIsHome, TemplateRequestBody requestBody)
      Create a new metadata element to represent a data field using an existing metadata element as a template.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      parentGUID - unique identifier of the parent element where the schema is located
      applicationIsHome - should the data field be marked as owned by the event broker so others can not update?
      requestBody - properties that override the template
      Returns:
      unique identifier of the new data field or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateDataContainer

      public VoidResponse updateDataContainer(String serverName, String userId, String dataContainerGUID, boolean isMergeUpdate, DataContainerRequestBody requestBody)
      Update the metadata element representing a data field.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      dataContainerGUID - unique identifier of the metadata element to update
      isMergeUpdate - are unspecified properties unchanged (true) or removed?
      requestBody - new properties for the metadata element
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • removeDataContainer

      public VoidResponse removeDataContainer(String serverName, String userId, String dataContainerGUID, String qualifiedName, MetadataSourceRequestBody requestBody)
      Remove the metadata element representing a data container.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      dataContainerGUID - unique identifier of the metadata element to remove
      qualifiedName - unique name of the metadata element to remove
      requestBody - external source identifiers
      Returns:
      void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • findDataContainers

      public DataContainersResponse findDataContainers(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of data field metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getDataContainersForParent

      public DataContainersResponse getDataContainersForParent(String serverName, String userId, String parentGUID, int startFrom, int pageSize)
      Return the list of schemas associated with a parent element .
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      parentGUID - unique identifier of the parent element to query
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of metadata elements describing the schemas associated with the requested parent element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getDataContainersByName

      public DataContainersResponse getDataContainersByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of data field metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getDataContainerByGUID

      public DataContainerResponse getDataContainerByGUID(String serverName, String userId, String guid)
      Retrieve the data field metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - unique identifier of the requested metadata element
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)