Class DisplayIntegratorContext
java.lang.Object
org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
org.odpi.openmetadata.integrationservices.display.connector.DisplayIntegratorContext
DisplayIntegratorContext is the context for cataloging topics from a display application server.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
actionControlInterface, connectorName, externalSourceGUID, externalSourceIsHome, externalSourceName, fileClassifier, governanceConfiguration, integrationConnectorGUID, integrationReportWriter, maxPageSize, openIntegrationClient, openMetadataStoreClient, permittedSynchronization, propertyHelper, userId
-
Constructor Summary
ConstructorsConstructorDescriptionDisplayIntegratorContext
(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, DisplayApplicationClient displayApplicationClient, DataManagerEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, AuditLog auditLog, int maxPageSize) Create a new client with no authentication embedded in the HTTP request. -
Method Summary
Modifier and TypeMethodDescriptioncreateDataContainer
(String parentElementGUID, DataContainerProperties dataContainerProperties) Create a new metadata element to represent a data container.createDataContainerFromTemplate
(String parentElementGUID, String templateGUID, TemplateProperties templateProperties) Create a new metadata element to represent a data container using an existing metadata element as a template.createDataField
(String parentElementGUID, DataFieldProperties properties) Create a new metadata element to represent a data field.createDataFieldFromTemplate
(String templateGUID, String parentElementGUID, TemplateProperties templateProperties) Create a new metadata element to represent a data field using an existing metadata element as a template.createForm
(FormProperties formProperties) Create a new metadata element to represent a form.createFormFromTemplate
(String templateGUID, TemplateProperties templateProperties) Create a new metadata element to represent a form using an existing metadata element as a template.createQuery
(QueryProperties queryProperties) Create a new metadata element to represent a query.createQueryFromTemplate
(String templateGUID, TemplateProperties templateProperties) Create a new metadata element to represent a query using an existing metadata element as a template.createReport
(ReportProperties reportProperties) Create a new metadata element to represent a report.createReportFromTemplate
(String templateGUID, TemplateProperties templateProperties) Create a new metadata element to represent a report using an existing metadata element as a template.findDataContainers
(String typeName, String searchString, int startFrom, int pageSize) Retrieve the list of data container metadata elements that contain the search string.findDataFields
(String searchString, int startFrom, int pageSize) Retrieve the list of data field metadata elements that contain the search string.Retrieve the list of form metadata elements that contain the search string.findQueries
(String searchString, int startFrom, int pageSize) Retrieve the list of query metadata elements that contain the search string.findReports
(String searchString, int startFrom, int pageSize) Retrieve the list of report metadata elements that contain the search string.getChildDataFields
(String parentElementGUID, int startFrom, int pageSize) Return the list of data-fields associated with an element.getDataContainerByGUID
(String dataContainerGUID) Retrieve the data container metadata element with the supplied unique identifier.getDataContainerByName
(String name, String typeName, int startFrom, int pageSize) Retrieve the list of data container metadata elements with a matching qualified or display name.getDataContainerParent
(String dataContainerGUID) Retrieve the header of the metadata element connected to a data container.getDataContainersForElement
(String parentElementGUID, int startFrom, int pageSize) Return the data container associated with a specific open metadata element (data asset, process or port).getDataFieldByGUID
(String guid) Retrieve the data field metadata element with the supplied unique identifier.getDataFieldsByName
(String name, int startFrom, int pageSize) Retrieve the list of data field metadata elements with a matching qualified or display name.getFormByGUID
(String guid) Retrieve the form metadata element with the supplied unique identifier.getFormsByName
(String name, int startFrom, int pageSize) Retrieve the list of form metadata elements with a matching qualified or display name.getFormsForApplication
(int startFrom, int pageSize) Retrieve the list of forms created by this caller.getQueriesByName
(String name, int startFrom, int pageSize) Retrieve the list of query metadata elements with a matching qualified or display name.getQueriesForApplication
(int startFrom, int pageSize) Retrieve the list of queries created by this caller.getQueryByGUID
(String guid) Retrieve the query metadata element with the supplied unique identifier.getReportByGUID
(String guid) Retrieve the report metadata element with the supplied unique identifier.getReportsByName
(String name, int startFrom, int pageSize) Retrieve the list of report metadata elements with a matching qualified or display name.getReportsForApplication
(int startFrom, int pageSize) Retrieve the list of reports created by this caller.void
publishForm
(String formGUID) Update the zones for the form asset so that it becomes visible to consumers.void
publishQuery
(String queryGUID) Update the zones for the query asset so that it becomes visible to consumers.void
publishReport
(String reportGUID) Update the zones for the report asset so that it becomes visible to consumers.void
registerListener
(DataManagerEventListener listener) Register a listener object that will be passed each of the events published by the Data Manager OMAS.void
removeDataContainer
(String dataContainerGUID) Remove the metadata element representing a data container.void
removeDataField
(String dataFieldGUID) Remove the metadata element representing a data field.void
removeForm
(String formGUID, String qualifiedName) Remove the metadata element representing a form.void
removeQuery
(String queryGUID, String qualifiedName) Remove the metadata element representing a query.void
removeReport
(String reportGUID, String qualifiedName) Remove the metadata element representing a report.void
setupSchemaType
(String relationshipTypeName, String dataFieldGUID, String schemaTypeGUID) Connect a schema type to a data field.void
updateDataContainer
(String dataContainerGUID, boolean isMergeUpdate, DataContainerProperties dataContainerProperties) Update the metadata element representing a data container.void
updateDataField
(String dataFieldGUID, boolean isMergeUpdate, DataFieldProperties properties) Update the metadata element representing a data field.void
updateForm
(String formGUID, boolean isMergeUpdate, FormProperties formProperties) Update the metadata element representing a form.void
updateQuery
(String queryGUID, boolean isMergeUpdate, QueryProperties queryProperties) Update the metadata element representing a query.void
updateReport
(String reportGUID, boolean isMergeUpdate, ReportProperties reportProperties) Update the metadata element representing a report.void
withdrawForm
(String formGUID) Update the zones for the form asset so that it is no longer visible to consumers.void
withdrawQuery
(String queryGUID) Update the zones for the query asset so that it is no longer visible to consumers.void
withdrawReport
(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.frameworks.integration.context.IntegrationContext
addCatalogTarget, addCatalogTarget, disconnect, elementShouldBeCatalogued, getAnchorGUID, getAnchorGUID, getCatalogTarget, getCatalogTargets, getCatalogTargets, getConnectedAssetContext, getExternalSourceIsHome, getFileClassifier, getIntegrationGovernanceContext, getMaxPageSize, getMetadataSourceGUID, getMetadataSourceQualifiedName, getMyUserId, getPermittedSynchronization, isRefreshInProgress, isTypeOf, isTypeOf, registerDirectoryListener, registerDirectoryTreeListener, registerFileListener, removeCatalogTarget, reportAnchorGUID, reportAnchorGUID, reportElementCreation, reportElementDelete, reportElementUpdate, reportParentGUID, setActiveReportPublishing, setExternalSourceIsHome, setMetadataSourceQualifiedName, setMetadataSourceQualifiedName, unregisterDirectoryListener, unregisterDirectoryTreeListener, unregisterFileListener, updateCatalogTarget
-
Constructor Details
-
DisplayIntegratorContext
public DisplayIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, DisplayApplicationClient displayApplicationClient, DataManagerEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, AuditLog auditLog, int maxPageSize) Create a new client with no authentication embedded in the HTTP request.- Parameters:
connectorId
- unique identifier of the connector (used to configure the event listener)connectorName
- name of connector from configconnectorUserId
- userId for the connectorserverName
- name of the integration daemonopenIntegrationClient
- client for calling the metadata servergovernanceConfiguration
- client for managing catalog targetsopenMetadataStoreClient
- client for calling the metadata serveractionControlInterface
- client for initiating governance actionsdisplayApplicationClient
- client to map request toeventClient
- client to register for eventsgenerateIntegrationReport
- should the connector generate an integration reports?permittedSynchronization
- the direction of integration permitted by the integration connectorintegrationConnectorGUID
- unique identifier for the integration connector if it is started via an integration group (otherwise it is null).externalSourceGUID
- unique identifier of the software server capability for the asset managerexternalSourceName
- unique name of the software server capability for the asset managerauditLog
- logging destinationmaxPageSize
- max number of elements that can be returned on a query
-
-
Method Details
-
registerListener
public void registerListener(DataManagerEventListener listener) throws InvalidParameterException, ConnectionCheckedException, ConnectorCheckedException, PropertyServerException, UserNotAuthorizedException Register a listener object that will be passed each of the events published by the Data Manager OMAS.- Parameters:
listener
- listener object- Throws:
InvalidParameterException
- one of the parameters is null or invalid.ConnectionCheckedException
- there are errors in the configuration of the connection which is preventing the creation of a connector.ConnectorCheckedException
- there are errors in the initialization of the connector.PropertyServerException
- there is a problem retrieving information from the property server(s).UserNotAuthorizedException
- the requesting user is not authorized to issue this request.
-
createForm
public String createForm(FormProperties formProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a form.- Parameters:
formProperties
- properties to store- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createFormFromTemplate
public String createFormFromTemplate(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.- Parameters:
templateGUID
- unique identifier of the metadata element to copytemplateProperties
- properties that override the template- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateForm
public void updateForm(String formGUID, boolean isMergeUpdate, FormProperties formProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the metadata element representing a form.- Parameters:
formGUID
- unique identifier of the metadata element to updateisMergeUpdate
- are unspecified properties unchanged (true) or removed?formProperties
- new properties for this element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
publishForm
public void publishForm(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).- Parameters:
formGUID
- unique identifier of the metadata element to publish- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
withdrawForm
public void withdrawForm(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).- Parameters:
formGUID
- unique identifier of the metadata element to withdraw- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeForm
public void removeForm(String formGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element representing a form.- Parameters:
formGUID
- unique identifier of the metadata element to removequalifiedName
- unique name of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
findForms
public List<FormElement> findForms(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.- Parameters:
searchString
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getFormsByName
public List<FormElement> getFormsByName(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.- Parameters:
name
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getFormsForApplication
public List<FormElement> getFormsForApplication(int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of forms created by this caller.- Parameters:
startFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getFormByGUID
public FormElement getFormByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the form metadata element with the supplied unique identifier.- Parameters:
guid
- unique identifier of the requested metadata element- Returns:
- matching metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createReport
public String createReport(ReportProperties reportProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a report.- Parameters:
reportProperties
- properties to store- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createReportFromTemplate
public String createReportFromTemplate(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.- Parameters:
templateGUID
- unique identifier of the metadata element to copytemplateProperties
- properties that override the template- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateReport
public void updateReport(String reportGUID, boolean isMergeUpdate, ReportProperties reportProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the metadata element representing a report.- Parameters:
reportGUID
- unique identifier of the metadata element to updateisMergeUpdate
- are unspecified properties unchanged (true) or removed?reportProperties
- new properties for this element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
publishReport
public void publishReport(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).- Parameters:
reportGUID
- unique identifier of the metadata element to publish- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
withdrawReport
public void withdrawReport(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).- Parameters:
reportGUID
- unique identifier of the metadata element to withdraw- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeReport
public void removeReport(String reportGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element representing a report.- Parameters:
reportGUID
- unique identifier of the metadata element to removequalifiedName
- unique name of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
findReports
public List<ReportElement> findReports(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.- Parameters:
searchString
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getReportsByName
public List<ReportElement> getReportsByName(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.- Parameters:
name
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getReportsForApplication
public List<ReportElement> getReportsForApplication(int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of reports created by this caller.- Parameters:
startFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getReportByGUID
public ReportElement getReportByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the report metadata element with the supplied unique identifier.- Parameters:
guid
- unique identifier of the requested metadata element- Returns:
- matching metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createQuery
public String createQuery(QueryProperties queryProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a query.- Parameters:
queryProperties
- properties to store- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createQueryFromTemplate
public String createQueryFromTemplate(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.- Parameters:
templateGUID
- unique identifier of the metadata element to copytemplateProperties
- properties that override the template- Returns:
- unique identifier of the new metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateQuery
public void updateQuery(String queryGUID, boolean isMergeUpdate, QueryProperties queryProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the metadata element representing a query.- Parameters:
queryGUID
- unique identifier of the metadata element to updateisMergeUpdate
- are unspecified properties unchanged (true) or removed?queryProperties
- new properties for this element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
publishQuery
public void publishQuery(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).- Parameters:
queryGUID
- unique identifier of the metadata element to publish- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
withdrawQuery
public void withdrawQuery(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).- Parameters:
queryGUID
- unique identifier of the metadata element to withdraw- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeQuery
public void removeQuery(String queryGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element representing a query.- Parameters:
queryGUID
- unique identifier of the metadata element to removequalifiedName
- unique name of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
findQueries
public List<QueryElement> findQueries(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.- Parameters:
searchString
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getQueriesByName
public List<QueryElement> getQueriesByName(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.- Parameters:
name
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getQueriesForApplication
public List<QueryElement> getQueriesForApplication(int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the list of queries created by this caller.- Parameters:
startFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getQueryByGUID
public QueryElement getQueryByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the query metadata element with the supplied unique identifier.- Parameters:
guid
- unique identifier of the requested metadata element- Returns:
- matching metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createDataContainer
public String createDataContainer(String parentElementGUID, DataContainerProperties dataContainerProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a data container.- Parameters:
parentElementGUID
- element to link the data container todataContainerProperties
- properties about the data container to store- Returns:
- unique identifier of the new data container
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createDataContainerFromTemplate
public String createDataContainerFromTemplate(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.- Parameters:
parentElementGUID
- element to link the data container totemplateGUID
- unique identifier of the metadata element to copytemplateProperties
- properties that override the template- Returns:
- unique identifier of the new data container
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateDataContainer
public void updateDataContainer(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.- Parameters:
dataContainerGUID
- unique identifier of the metadata element to updateisMergeUpdate
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeDataContainer
public void removeDataContainer(String dataContainerGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element representing a data container.- Parameters:
dataContainerGUID
- unique identifier of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
findDataContainers
public List<DataContainerElement> findDataContainers(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.- Parameters:
searchString
- string to find in the propertiestypeName
- optional type name for the data container - used to restrict the search resultsstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataContainersForElement
public List<DataContainerElement> getDataContainersForElement(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).- Parameters:
parentElementGUID
- unique identifier of the open metadata element that this data container is connected tostartFrom
- paging start pointpageSize
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataContainerByName
public List<DataContainerElement> getDataContainerByName(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.- Parameters:
name
- name to search fortypeName
- optional type name for the data container - used to restrict the search resultsstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataContainerByGUID
public DataContainerElement getDataContainerByGUID(String dataContainerGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the data container metadata element with the supplied unique identifier.- Parameters:
dataContainerGUID
- unique identifier of the requested metadata element- Returns:
- requested metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataContainerParent
public ElementStub getDataContainerParent(String dataContainerGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the header of the metadata element connected to a data container.- Parameters:
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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createDataField
public String createDataField(String parentElementGUID, DataFieldProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a new metadata element to represent a data field.- Parameters:
parentElementGUID
- unique identifier of the element where the data field is locatedproperties
- properties about the data field- Returns:
- unique identifier of the new data field
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
createDataFieldFromTemplate
public String createDataFieldFromTemplate(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.- Parameters:
templateGUID
- unique identifier of the metadata element to copyparentElementGUID
- unique identifier of the report where the data field is locatedtemplateProperties
- properties that override the template- Returns:
- unique identifier of the new data field
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
setupSchemaType
public void setupSchemaType(String relationshipTypeName, String dataFieldGUID, String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Connect a schema type to a data field.- Parameters:
relationshipTypeName
- name of relationship to createdataFieldGUID
- unique identifier of the data fieldschemaTypeGUID
- unique identifier of the schema type to connect- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
updateDataField
public void updateDataField(String dataFieldGUID, boolean isMergeUpdate, DataFieldProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Update the metadata element representing a data field.- Parameters:
dataFieldGUID
- unique identifier of the metadata element to updateisMergeUpdate
- are unspecified properties unchanged (true) or removed?properties
- new properties for the metadata element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
removeDataField
public void removeDataField(String dataFieldGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the metadata element representing a data field.- Parameters:
dataFieldGUID
- unique identifier of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
findDataFields
public List<DataFieldElement> findDataFields(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.- Parameters:
searchString
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getChildDataFields
public List<DataFieldElement> getChildDataFields(String parentElementGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return the list of data-fields associated with an element.- Parameters:
parentElementGUID
- unique identifier of the element to querystartFrom
- paging start pointpageSize
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataFieldsByName
public List<DataFieldElement> getDataFieldsByName(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.- Parameters:
name
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getDataFieldByGUID
public DataFieldElement getDataFieldByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Retrieve the data field metadata element with the supplied unique identifier.- Parameters:
guid
- unique identifier of the requested metadata element- Returns:
- requested metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-