Package org.odpi.openmetadata.frameworkservices.omf.client

Class EgeriaOpenMetadataStoreClient

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.client.OpenMetadataClient

org.odpi.openmetadata.frameworkservices.omf.client.OpenMetadataClientBase

org.odpi.openmetadata.frameworkservices.omf.client.EgeriaOpenMetadataStoreClient

All Implemented Interfaces:

ExternalIdentifiersInterface, MetadataElementInterface, MultiLanguageInterface, OpenMetadataTypesInterface, StewardshipRequestInterface

public class EgeriaOpenMetadataStoreClient
extends OpenMetadataClientBase

EgeriaOpenMetadataStoreClient provides an interface to the open metadata store. This is part of the Open Metadata Framework (OMF) 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.omf.client.OpenMetadataClientBase

elementBuilder, invalidParameterHandler, relationshipBuilder

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.client.OpenMetadataClient

serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
EgeriaOpenMetadataStoreClient(String serverName, String serverPlatformURLRoot, String secretsStoreProvider, String secretsStoreLocation, String secretsStoreCollection, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
EgeriaOpenMetadataStoreClient(String serverName, String serverPlatformURLRoot, Map<String,SecretsStoreConnector> secretsStoreConnectorMap, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

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

archiveMetadataElementInStore, classifyMetadataElementInStore, clearTranslation, createActorAction, createIncidentReport, createMetadataElementFromTemplate, createMetadataElementInStore, createNoteLogEntry, createRelatedElementsInStore, declassifyMetadataElementInStore, deleteMetadataElementInStore, deleteRelationshipInStore, detachRelatedElementsInStore, findAttributeTypeDefsByCategory, findElementsForAnchor, findElementsInAnchorDomain, findElementsInAnchorScope, findMetadataElements, findMetadataElementsWithString, findRelationshipsBetweenMetadataElements, findTypeDefsByCategory, findTypesByExternalId, getAllTypes, getAnchoredElementsGraph, getAttributeTypeDefByGUID, getAttributeTypeDefByName, getClassificationHistory, getMaxPagingSize, getMetadataElementByGUID, getMetadataElementByUniqueName, getMetadataElementGUIDByUniqueName, getMetadataElementHistory, getMetadataElementRelationships, getRelatedMetadataElement, getRelatedMetadataElements, getRelationshipByGUID, getRelationshipHistory, getSpecification, getSubTypes, getTranslation, getTranslations, getTypeDefByGUID, getTypeDefByName, openToDo, publishMetadataElement, reclassifyMetadataElementInStore, registerContextEvent, setMaxPageSize, setTranslation, updateClassificationEffectivityInStore, updateMetadataElementEffectivityInStore, updateMetadataElementInStore, updateRelatedElementsInStore, updateRelationshipEffectivityInStore, updateRelationshipInStore, withdrawMetadataElement

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

createMetadataElementInStore, createMetadataElementInStore, findMetadataElementsByClassificationPropertyValue, findMetadataElementsByClassificationPropertyValue, findMetadataElementsByPropertyValue, findMetadataElementsByPropertyValue, getDeletedElementByUniqueName, getMetadataElementsByClassification, getMetadataElementsByClassificationPropertyValue, getMetadataElementsByClassificationPropertyValue, getMetadataElementsByClassificationPropertyValue, getMetadataElementsByPropertyValue, getMetadataElementsByPropertyValue, getServerName, getServerPlatformURLRoot, toString

Methods inherited from class java.lang.Object

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

Constructor Details

EgeriaOpenMetadataStoreClient

public EgeriaOpenMetadataStoreClient(String serverName,
 String serverPlatformURLRoot,
 String secretsStoreProvider,
 String secretsStoreLocation,
 String secretsStoreCollection,
 int maxPageSize,
 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

secretsStoreProvider - secrets store connector for bearer token

secretsStoreLocation - secrets store location for bearer token

secretsStoreCollection - secrets store collection for bearer token

maxPageSize - maximum value allowed for page size

auditLog - logging destination

Throws:

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

EgeriaOpenMetadataStoreClient

public EgeriaOpenMetadataStoreClient(String serverName,
 String serverPlatformURLRoot,
 Map<String,SecretsStoreConnector> secretsStoreConnectorMap,
 int maxPageSize,
 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

secretsStoreConnectorMap - connectors to secrets stores

maxPageSize - maximum value allowed for page size

auditLog - logging destination

Throws:

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