Class OpenMetadataStoreClient
java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient
org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase
org.odpi.openmetadata.accessservices.assetconsumer.client.OpenMetadataStoreClient
- All Implemented Interfaces:
ExternalIdentifiersInterface
,MetadataElementInterface
,MultiLanguageInterface
,OpenMetadataTypesInterface
,StewardshipRequestInterface
,ValidMetadataValuesInterface
OpenMetadataClientBase 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.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase
invalidParameterHandler
Fields inherited from class org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient
serverName, serverPlatformURLRoot
-
Constructor Summary
ConstructorDescriptionOpenMetadataStoreClient
(String serverName, String serverPlatformURLRoot, int maxPageSize) Create a new client with no authentication embedded in the HTTP request.OpenMetadataStoreClient
(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword, int maxPageSize) 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
addExternalIdentifier, archiveMetadataElementInStore, archiveMetadataElementInStore, classifyMetadataElementInStore, classifyMetadataElementInStore, clearTranslation, clearValidMetadataMapName, clearValidMetadataMapValue, clearValidMetadataValue, confirmSynchronization, createIncidentReport, createMetadataElementFromTemplate, createMetadataElementFromTemplate, createMetadataElementInStore, createMetadataElementInStore, createMetadataElementInStore, createMetadataElementInStore, createRelatedElementsInStore, createRelatedElementsInStore, declassifyMetadataElementInStore, declassifyMetadataElementInStore, deleteMetadataElementInStore, deleteMetadataElementInStore, deleteRelatedElementsInStore, deleteRelatedElementsInStore, findAttributeTypeDefsByCategory, findMetadataElements, findMetadataElementsByClassificationPropertyValue, findMetadataElementsByClassificationPropertyValue, findMetadataElementsByPropertyValue, findMetadataElementsByPropertyValue, findMetadataElementsWithString, findMetadataElementsWithString, findRelationshipsBetweenMetadataElements, findTypeDefsByCategory, findTypesByExternalId, getAllTypes, getAttributeTypeDefByGUID, getAttributeTypeDefByName, getConsistentMetadataValues, getDeletedElementByUniqueName, getEffectiveTimeQueryRequestBody, getElementsForExternalIdentifier, getMaxPagingSize, getMetadataCorrelationHeaders, getMetadataElementByGUID, getMetadataElementByUniqueName, getMetadataElementFromTemplate, getMetadataElementGUIDByUniqueName, getMetadataElementRelationships, getMetadataElementsByClassification, getMetadataElementsByClassificationPropertyValue, getMetadataElementsByClassificationPropertyValue, getMetadataElementsByClassificationPropertyValue, getMetadataElementsByPropertyValue, getMetadataElementsByPropertyValue, getRelatedMetadataElement, getRelatedMetadataElements, getRelationshipByGUID, getSpecification, getSubTypes, getTranslation, getTranslations, getTypeDefByGUID, getTypeDefByName, getValidMetadataMapName, getValidMetadataMapValue, getValidMetadataValue, getValidMetadataValues, getVendorProperties, initiateGovernanceActionProcess, openToDo, reclassifyMetadataElementInStore, reclassifyMetadataElementInStore, removeExternalIdentifier, setConsistentMetadataValues, setMaxPageSize, setTranslation, setUpValidMetadataMapName, setUpValidMetadataMapValue, setUpValidMetadataValue, updateClassificationEffectivityInStore, updateClassificationEffectivityInStore, updateExternalIdentifier, updateMetadataElementEffectivityInStore, updateMetadataElementEffectivityInStore, updateMetadataElementInStore, updateMetadataElementInStore, updateMetadataElementStatusInStore, updateMetadataElementStatusInStore, updateRelatedElementsEffectivityInStore, updateRelatedElementsEffectivityInStore, updateRelatedElementsInStore, updateRelatedElementsInStore, validateExternalIdentifier, validateMetadataMapName, validateMetadataMapValue, validateMetadataValue
Methods inherited from class org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient
getServerName, toString
-
Constructor Details
-
OpenMetadataStoreClient
public OpenMetadataStoreClient(String serverName, String serverPlatformURLRoot, int maxPageSize) throws InvalidParameterException Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesmaxPageSize
- maximum value allowed for page size- Throws:
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, int maxPageSize) 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 toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesserverUserId
- caller's userId embedded in all HTTP requestsserverPassword
- caller's password embedded in all HTTP requestsmaxPageSize
- maximum value allowed for page size- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-