Package org.odpi.openmetadata.accessservices.assetcatalog

Class OpenMetadataStoreClient

java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient
org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase
org.odpi.openmetadata.accessservices.assetcatalog.OpenMetadataStoreClient
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.governanceaction.client.MetadataElementInterface, org.odpi.openmetadata.frameworks.governanceaction.client.MultiLanguageInterface, org.odpi.openmetadata.frameworks.governanceaction.client.StewardshipActionInterface, org.odpi.openmetadata.frameworks.governanceaction.client.ValidMetadataValuesInterface
public class OpenMetadataStoreClient extends org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase
OpenMetadataStoreClient provides an interface to the open metadata store. This is part of the Governance Action Framework (GAF) and provides a comprehensive interface for working with all types of metadata, subject to the user's (and this OMAS's) security permissions. The interface supports search, maintenance of metadata elements, classifications and relationships plus the ability to raise incident reports and todos along with the ability to work with metadata valid values and translations.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenMetadataStoreClient(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    OpenMetadataStoreClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword)
    Create a new client that passes userId and password in each HTTP request.

  • Method Summary

    Methods inherited from class org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase

    classifyMetadataElementInStore, classifyMetadataElementInStore, clearTranslation, clearValidMetadataMapName, clearValidMetadataMapValue, clearValidMetadataValue, createIncidentReport, createMetadataElementInStore, createMetadataElementInStore, createRelatedElementsInStore, createRelatedElementsInStore, declassifyMetadataElementInStore, declassifyMetadataElementInStore, deleteMetadataElementInStore, deleteMetadataElementInStore, deleteRelatedElementsInStore, deleteRelatedElementsInStore, findMetadataElements, findMetadataElementsWithString, findRelationshipsBetweenMetadataElements, getMetadataElementByGUID, getMetadataElementByUniqueName, getMetadataElementGUIDByUniqueName, getRelatedMetadataElements, getTranslation, getTranslations, getValidMetadataMapName, getValidMetadataMapValue, getValidMetadataValue, getValidMetadataValues, initiateGovernanceActionProcess, openToDo, openToDo, reclassifyMetadataElementInStore, reclassifyMetadataElementInStore, setTranslation, setUpValidMetadataMapName, setUpValidMetadataMapValue, setUpValidMetadataValue, updateClassificationEffectivityInStore, updateClassificationEffectivityInStore, updateMetadataElementEffectivityInStore, updateMetadataElementEffectivityInStore, updateMetadataElementInStore, updateMetadataElementInStore, updateMetadataElementStatusInStore, updateMetadataElementStatusInStore, updateRelatedElementsEffectivityInStore, updateRelatedElementsEffectivityInStore, updateRelatedElementsInStore, updateRelatedElementsInStore, validateMetadataMapName, validateMetadataMapValue, validateMetadataValue

    Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient

    toString

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • OpenMetadataStoreClient

      public OpenMetadataStoreClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • OpenMetadataStoreClient

      public OpenMetadataStoreClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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
      serverUserId - caller's userId embedded in all HTTP requests
      serverPassword - caller's password embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.