Class DisplayApplicationClient

    • Constructor Summary

      Constructors 
      Constructor Description
      DisplayApplicationClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      DisplayApplicationClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      DisplayApplicationClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      DisplayApplicationClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)
      Create a new client that is going to be used in an OMAG Server.
      DisplayApplicationClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String createDataContainer​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, java.lang.String parentElementGUID, DataContainerProperties dataContainerProperties)
      Create a new metadata element to represent a data container.
      java.lang.String createDataContainerFromTemplate​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, java.lang.String parentElementGUID, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a data container using an existing metadata element as a template.
      java.lang.String createDataField​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, java.lang.String parentElementGUID, DataFieldProperties properties)
      Create a new metadata element to represent a data field.
      java.lang.String createDataFieldFromTemplate​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, java.lang.String templateGUID, java.lang.String parentElementGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a data field using an existing metadata element as a template.
      java.lang.String createForm​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, FormProperties formProperties)
      Create a new metadata element to represent a form.
      java.lang.String createFormFromTemplate​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a form using an existing metadata element as a template.
      java.lang.String createQuery​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, QueryProperties queryProperties)
      Create a new metadata element to represent a query.
      java.lang.String createQueryFromTemplate​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a query using an existing metadata element as a template.
      java.lang.String createReport​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, ReportProperties reportProperties)
      Create a new metadata element to represent a report.
      java.lang.String createReportFromTemplate​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a report using an existing metadata element as a template.
      java.util.List<DataContainerElement> findDataContainers​(java.lang.String userId, java.lang.String typeName, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of data container metadata elements that contain the search string.
      java.util.List<DataFieldElement> findDataFields​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of data field metadata elements that contain the search string.
      java.util.List<FormElement> findForms​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of form metadata elements that contain the search string.
      java.util.List<QueryElement> findQueries​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of query metadata elements that contain the search string.
      java.util.List<ReportElement> findReports​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of report metadata elements that contain the search string.
      java.util.List<DataFieldElement> getChildDataFields​(java.lang.String userId, java.lang.String parentElementGUID, int startFrom, int pageSize)
      Return the list of data-fields associated with a element.
      DataContainerElement getDataContainerByGUID​(java.lang.String userId, java.lang.String dataContainerGUID)
      Retrieve the data container metadata element with the supplied unique identifier.
      java.util.List<DataContainerElement> getDataContainerByName​(java.lang.String userId, java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of data container metadata elements with a matching qualified or display name.
      ElementStub getDataContainerParent​(java.lang.String userId, java.lang.String dataContainerGUID)
      Retrieve the header of the metadata element connected to a data container.
      java.util.List<DataContainerElement> getDataContainersForElement​(java.lang.String userId, java.lang.String parentElementGUID, int startFrom, int pageSize)
      Return the data container associated with a specific open metadata element (data asset, process or port).
      DataFieldElement getDataFieldByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the data field metadata element with the supplied unique identifier.
      java.util.List<DataFieldElement> getDataFieldsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of data field metadata elements with a matching qualified or display name.
      FormElement getFormByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the form metadata element with the supplied unique identifier.
      java.util.List<FormElement> getFormsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of form metadata elements with a matching qualified or display name.
      java.util.List<FormElement> getFormsForApplication​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, int startFrom, int pageSize)
      Retrieve the list of forms created by this caller.
      java.util.List<QueryElement> getQueriesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of query metadata elements with a matching qualified or display name.
      java.util.List<QueryElement> getQueriesForApplication​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, int startFrom, int pageSize)
      Retrieve the list of queries created by this caller.
      QueryElement getQueryByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the query metadata element with the supplied unique identifier.
      ReportElement getReportByGUID​(java.lang.String userId, java.lang.String guid)
      Retrieve the report metadata element with the supplied unique identifier.
      java.util.List<ReportElement> getReportsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of report metadata elements with a matching qualified or display name.
      java.util.List<ReportElement> getReportsForApplication​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, int startFrom, int pageSize)
      Retrieve the list of reports created by this caller.
      void publishForm​(java.lang.String userId, java.lang.String formGUID)
      Update the zones for the form asset so that it becomes visible to consumers.
      void publishQuery​(java.lang.String userId, java.lang.String queryGUID)
      Update the zones for the query asset so that it becomes visible to consumers.
      void publishReport​(java.lang.String userId, java.lang.String reportGUID)
      Update the zones for the report asset so that it becomes visible to consumers.
      void removeDataContainer​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String dataContainerGUID)
      Remove the metadata element representing a data container.
      void removeDataField​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String dataFieldGUID)
      Remove the metadata element representing a data field.
      void removeForm​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String formGUID, java.lang.String qualifiedName)
      Remove the metadata element representing a form.
      void removeQuery​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String queryGUID, java.lang.String qualifiedName)
      Remove the metadata element representing a query.
      void removeReport​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String reportGUID, java.lang.String qualifiedName)
      Remove the metadata element representing a report.
      void setupSchemaType​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, boolean applicationIsHome, java.lang.String relationshipTypeName, java.lang.String apiParameterGUID, java.lang.String schemaTypeGUID)
      Connect a schema type to a data field.
      void updateDataContainer​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String dataContainerGUID, boolean isMergeUpdate, DataContainerProperties dataContainerProperties)
      Update the metadata element representing a data container.
      void updateDataField​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String dataFieldGUID, boolean isMergeUpdate, DataFieldProperties properties)
      Update the metadata element representing a data field.
      void updateForm​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String formGUID, boolean isMergeUpdate, FormProperties formProperties)
      Update the metadata element representing a form.
      void updateQuery​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String queryGUID, boolean isMergeUpdate, QueryProperties queryProperties)
      Update the metadata element representing a query.
      void updateReport​(java.lang.String userId, java.lang.String applicationGUID, java.lang.String applicationName, java.lang.String reportGUID, boolean isMergeUpdate, ReportProperties reportProperties)
      Update the metadata element representing a report.
      void withdrawForm​(java.lang.String userId, java.lang.String formGUID)
      Update the zones for the form asset so that it is no longer visible to consumers.
      void withdrawQuery​(java.lang.String userId, java.lang.String queryGUID)
      Update the zones for the query asset so that it is no longer visible to consumers.
      void withdrawReport​(java.lang.String userId, java.lang.String reportGUID)
      Update the zones for the report asset so that it is no longer visible to consumers.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DisplayApplicationClient

        public DisplayApplicationClient​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        AuditLog auditLog)
                                 throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • DisplayApplicationClient

        public DisplayApplicationClient​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot)
                                 throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • DisplayApplicationClient

        public DisplayApplicationClient​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        java.lang.String userId,
                                        java.lang.String password,
                                        AuditLog auditLog)
                                 throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • DisplayApplicationClient

        public DisplayApplicationClient​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        DataManagerRESTClient restClient,
                                        int maxPageSize,
                                        AuditLog auditLog)
                                 throws InvalidParameterException
        Create a new client that is going to be used in an OMAG Server.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - client that issues the REST API calls
        maxPageSize - maximum number of results supported by this server
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • DisplayApplicationClient

        public DisplayApplicationClient​(java.lang.String serverName,
                                        java.lang.String serverPlatformURLRoot,
                                        java.lang.String userId,
                                        java.lang.String password)
                                 throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.