Package org.odpi.openmetadata.accessservices.datamanager.client

Class DisplayApplicationClient

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient

org.odpi.openmetadata.accessservices.datamanager.client.SchemaManagerClient

org.odpi.openmetadata.accessservices.datamanager.client.DisplayApplicationClient

All Implemented Interfaces:

DisplayApplicationInterface, SchemaManagerInterface

public class DisplayApplicationClient
extends SchemaManagerClient
implements DisplayApplicationInterface

DisplayApplicationClient is the client for managing reports from an Application that displays data to users.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.client.SchemaManagerClient

clearCalculatedValue, clearQueryTargetRelationship, clearSchemaElementRelationship, clearSchemaTypes, createEnumSchemaType, createLiteralSchemaType, createMapSchemaType, createPrimitiveSchemaType, createSchemaAttribute, createSchemaAttributeFromTemplate, createSchemaTypeChoice, createSchemaTypeFromTemplate, createStructSchemaType, findSchemaAttributes, findSchemaType, findValidValueSet, getNestedAttributes, getSchemaAttributeByGUID, getSchemaAttributesByName, getSchemaTypeByGUID, getSchemaTypeByName, getSchemaTypeForElement, getSchemaTypeParent, getValidValueSetByName, removeSchemaAttribute, removeSchemaType, setupCalculatedValue, setupQueryTargetRelationship, setupSchemaElementRelationship, setupSchemaType, updateQueryTargetRelationship, updateSchemaAttribute, updateSchemaType

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient

removeReferenceable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DisplayApplicationClient

public DisplayApplicationClient(String serverName,
 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 services

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

DisplayApplicationClient

public DisplayApplicationClient(String serverName,
 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 services

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

DisplayApplicationClient

public DisplayApplicationClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 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 services

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(String serverName,
 String serverPlatformURLRoot,
 DataManagerRESTClient restClient,
 int maxPageSize)
                         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 services

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

DisplayApplicationClient

public DisplayApplicationClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 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 services

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.

Method Details

createForm

public String createForm(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 FormProperties formProperties)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a form.

Specified by:

createForm in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the form be marked as owned by the event broker so others can not update?

formProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createFormFromTemplate

public String createFormFromTemplate(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a form using an existing metadata element as a template.

Specified by:

createFormFromTemplate in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the form be marked as owned by the event broker so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateForm

public void updateForm(String userId,
 String applicationGUID,
 String applicationName,
 String formGUID,
 boolean isMergeUpdate,
 FormProperties formProperties)
                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a form.

Specified by:

updateForm in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

formGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

formProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishForm

public void publishForm(String userId,
 String formGUID)
                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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).

Specified by:

publishForm in interface DisplayApplicationInterface

Parameters:

userId - calling user

formGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawForm

public void withdrawForm(String userId,
 String formGUID)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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).

Specified by:

withdrawForm in interface DisplayApplicationInterface

Parameters:

userId - calling user

formGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeForm

public void removeForm(String userId,
 String applicationGUID,
 String applicationName,
 String formGUID,
 String qualifiedName)
                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a form.

Specified by:

removeForm in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

formGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findForms

public List<FormElement> findForms(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of form metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findForms in interface DisplayApplicationInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getFormsByName

public List<FormElement> getFormsByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of form metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getFormsByName in interface DisplayApplicationInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getFormsForApplication

public List<FormElement> getFormsForApplication(String userId,
 String applicationGUID,
 String applicationName,
 int startFrom,
 int pageSize)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of forms created by this caller.

Specified by:

getFormsForApplication in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the form manager (event broker)

applicationName - unique name of software server capability representing the form manager (event broker)

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getFormByGUID

public FormElement getFormByGUID(String userId,
 String guid)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the form metadata element with the supplied unique identifier.

Specified by:

getFormByGUID in interface DisplayApplicationInterface

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createReport

public String createReport(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 ReportProperties reportProperties)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a report.

Specified by:

createReport in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the report be marked as owned by the event broker so others can not update?

reportProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createReportFromTemplate

public String createReportFromTemplate(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a report using an existing metadata element as a template.

Specified by:

createReportFromTemplate in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the report be marked as owned by the event broker so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateReport

public void updateReport(String userId,
 String applicationGUID,
 String applicationName,
 String reportGUID,
 boolean isMergeUpdate,
 ReportProperties reportProperties)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a report.

Specified by:

updateReport in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

reportGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

reportProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishReport

public void publishReport(String userId,
 String reportGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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).

Specified by:

publishReport in interface DisplayApplicationInterface

Parameters:

userId - calling user

reportGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawReport

public void withdrawReport(String userId,
 String reportGUID)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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).

Specified by:

withdrawReport in interface DisplayApplicationInterface

Parameters:

userId - calling user

reportGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeReport

public void removeReport(String userId,
 String applicationGUID,
 String applicationName,
 String reportGUID,
 String qualifiedName)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a report.

Specified by:

removeReport in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

reportGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findReports

public List<ReportElement> findReports(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of report metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findReports in interface DisplayApplicationInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getReportsByName

public List<ReportElement> getReportsByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of report metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getReportsByName in interface DisplayApplicationInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getReportsForApplication

public List<ReportElement> getReportsForApplication(String userId,
 String applicationGUID,
 String applicationName,
 int startFrom,
 int pageSize)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of reports created by this caller.

Specified by:

getReportsForApplication in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the report manager (event broker)

applicationName - unique name of software server capability representing the report manager (event broker)

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getReportByGUID

public ReportElement getReportByGUID(String userId,
 String guid)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the report metadata element with the supplied unique identifier.

Specified by:

getReportByGUID in interface DisplayApplicationInterface

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createQuery

public String createQuery(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 QueryProperties queryProperties)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a query.

Specified by:

createQuery in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the query be marked as owned by the event broker so others can not update?

queryProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createQueryFromTemplate

public String createQueryFromTemplate(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 String templateGUID,
 TemplateProperties templateProperties)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a query using an existing metadata element as a template.

Specified by:

createQueryFromTemplate in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the query be marked as owned by the event broker so others can not update?

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateQuery

public void updateQuery(String userId,
 String applicationGUID,
 String applicationName,
 String queryGUID,
 boolean isMergeUpdate,
 QueryProperties queryProperties)
                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a query.

Specified by:

updateQuery in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

queryGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

queryProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishQuery

public void publishQuery(String userId,
 String queryGUID)
                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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).

Specified by:

publishQuery in interface DisplayApplicationInterface

Parameters:

userId - calling user

queryGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawQuery

public void withdrawQuery(String userId,
 String queryGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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).

Specified by:

withdrawQuery in interface DisplayApplicationInterface

Parameters:

userId - calling user

queryGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeQuery

public void removeQuery(String userId,
 String applicationGUID,
 String applicationName,
 String queryGUID,
 String qualifiedName)
                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a query.

Specified by:

removeQuery in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

queryGUID - unique identifier of the metadata element to remove

qualifiedName - unique name of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findQueries

public List<QueryElement> findQueries(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of query metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findQueries in interface DisplayApplicationInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getQueriesByName

public List<QueryElement> getQueriesByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of query metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getQueriesByName in interface DisplayApplicationInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getQueriesForApplication

public List<QueryElement> getQueriesForApplication(String userId,
 String applicationGUID,
 String applicationName,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of queries created by this caller.

Specified by:

getQueriesForApplication in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the query manager (event broker)

applicationName - unique name of software server capability representing the query manager (event broker)

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getQueryByGUID

public QueryElement getQueryByGUID(String userId,
 String guid)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the query metadata element with the supplied unique identifier.

Specified by:

getQueryByGUID in interface DisplayApplicationInterface

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataContainer

public String createDataContainer(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 String parentElementGUID,
 DataContainerProperties dataContainerProperties)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a data container.

Specified by:

createDataContainer in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the query be marked as owned by the event broker so others can not update?

parentElementGUID - element to link the data container to

dataContainerProperties - properties about the data container to store

Returns:

unique identifier of the new data container

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataContainerFromTemplate

public String createDataContainerFromTemplate(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 String parentElementGUID,
 String templateGUID,
 TemplateProperties templateProperties)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a data container using an existing metadata element as a template.

Specified by:

createDataContainerFromTemplate in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

applicationIsHome - should the query be marked as owned by the event broker so others can not update?

parentElementGUID - element to link the data container to

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new data container

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDataContainer

public void updateDataContainer(String userId,
 String applicationGUID,
 String applicationName,
 String dataContainerGUID,
 boolean isMergeUpdate,
 DataContainerProperties dataContainerProperties)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a data container. It is possible to use the subtype property classes or set up specialized properties in extended properties.

Specified by:

updateDataContainer in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

dataContainerGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

dataContainerProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDataContainer

public void removeDataContainer(String userId,
 String applicationGUID,
 String applicationName,
 String dataContainerGUID)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a data container.

Specified by:

removeDataContainer in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the caller

applicationName - unique name of software server capability representing the caller

dataContainerGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDataContainers

public List<DataContainerElement> findDataContainers(String userId,
 String typeName,
 String searchString,
 int startFrom,
 int pageSize)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of data container metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findDataContainers in interface DisplayApplicationInterface

Parameters:

userId - calling user

searchString - string to find in the properties

typeName - optional type name for the data container - used to restrict the search results

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataContainersForElement

public List<DataContainerElement> getDataContainersForElement(String userId,
 String parentElementGUID,
 int startFrom,
 int pageSize)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the data container associated with a specific open metadata element (data asset, process or port).

Specified by:

getDataContainersForElement in interface DisplayApplicationInterface

Parameters:

userId - calling user

parentElementGUID - unique identifier of the open metadata element that this data container is connected to

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

metadata element describing the data container associated with the requested parent element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataContainerByName

public List<DataContainerElement> getDataContainerByName(String userId,
 String name,
 String typeName,
 int startFrom,
 int pageSize)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of data container metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getDataContainerByName in interface DisplayApplicationInterface

Parameters:

userId - calling user

name - name to search for

typeName - optional type name for the data container - used to restrict the search results

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataContainerByGUID

public DataContainerElement getDataContainerByGUID(String userId,
 String dataContainerGUID)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the data container metadata element with the supplied unique identifier.

Specified by:

getDataContainerByGUID in interface DisplayApplicationInterface

Parameters:

userId - calling user

dataContainerGUID - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataContainerParent

public ElementStub getDataContainerParent(String userId,
 String dataContainerGUID)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the header of the metadata element connected to a data container.

Specified by:

getDataContainerParent in interface DisplayApplicationInterface

Parameters:

userId - calling user

dataContainerGUID - unique identifier of the requested metadata element

Returns:

header for parent element (data asset, process, port) plus qualified name

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataField

public String createDataField(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 String parentElementGUID,
 DataFieldProperties properties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a data field.

Specified by:

createDataField in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the data field be marked as owned by the event broker so others can not update?

parentElementGUID - unique identifier of the element where the data field is located

properties - properties about the data field

Returns:

unique identifier of the new data field

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createDataFieldFromTemplate

public String createDataFieldFromTemplate(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 String templateGUID,
 String parentElementGUID,
 TemplateProperties templateProperties)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a data field using an existing metadata element as a template.

Specified by:

createDataFieldFromTemplate in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the data field be marked as owned by the event broker so others can not update?

templateGUID - unique identifier of the metadata element to copy

parentElementGUID - unique identifier of the report where the data field is located

templateProperties - properties that override the template

Returns:

unique identifier of the new data field

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupSchemaType

public void setupSchemaType(String userId,
 String applicationGUID,
 String applicationName,
 boolean applicationIsHome,
 String relationshipTypeName,
 String apiParameterGUID,
 String schemaTypeGUID)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Connect a schema type to a data field.

Specified by:

setupSchemaType in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

applicationIsHome - should the data field be marked as owned by the event broker so others can not update?

relationshipTypeName - name of relationship to create

apiParameterGUID - unique identifier of the API parameter

schemaTypeGUID - unique identifier of the schema type to connect

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDataField

public void updateDataField(String userId,
 String applicationGUID,
 String applicationName,
 String dataFieldGUID,
 boolean isMergeUpdate,
 DataFieldProperties properties)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a data field.

Specified by:

updateDataField in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

dataFieldGUID - unique identifier of the metadata element to update

isMergeUpdate - are unspecified properties unchanged (true) or removed?

properties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeDataField

public void removeDataField(String userId,
 String applicationGUID,
 String applicationName,
 String dataFieldGUID)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a data field.

Specified by:

removeDataField in interface DisplayApplicationInterface

Parameters:

userId - calling user

applicationGUID - unique identifier of software server capability representing the event broker

applicationName - unique name of software server capability representing the event broker

dataFieldGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findDataFields

public List<DataFieldElement> findDataFields(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of data field metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findDataFields in interface DisplayApplicationInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getChildDataFields

public List<DataFieldElement> getChildDataFields(String userId,
 String parentElementGUID,
 int startFrom,
 int pageSize)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of data-fields associated with a element.

Specified by:

getChildDataFields in interface DisplayApplicationInterface

Parameters:

userId - calling user

parentElementGUID - unique identifier of the element to query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of metadata elements describing the data fields associated with the requested report

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataFieldsByName

public List<DataFieldElement> getDataFieldsByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of data field metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getDataFieldsByName in interface DisplayApplicationInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataFieldByGUID

public DataFieldElement getDataFieldByGUID(String userId,
 String guid)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the data field metadata element with the supplied unique identifier.

Specified by:

getDataFieldByGUID in interface DisplayApplicationInterface

Parameters:

userId - calling user

guid - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)