Package org.odpi.openmetadata.adminservices.client

Class MetadataAccessStoreConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.CohortMemberConfigurationClient

org.odpi.openmetadata.adminservices.client.MetadataAccessServerConfigurationClient

org.odpi.openmetadata.adminservices.client.MetadataAccessStoreConfigurationClient

public class MetadataAccessStoreConfigurationClient
extends MetadataAccessServerConfigurationClient

MetadataAccessStoreConfigurationClient provides the configuration client for a MetadataAccessServer OMAG server. A metadata access server is a metadata access point with a native open metadata repository.

Field Summary

Fields inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

adminUserId, invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
MetadataAccessStoreConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
MetadataAccessStoreConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL, String connectionUserId, String connectionPassword)	Create a new client that passes a connection userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
void	setGraphLocalRepository(Map<String,Object> storageProperties)	Set up a graph store as the local repository.
void	setInMemLocalRepository()	Set up an in memory local repository.
void	setPluginRepositoryConnection(String connectorProvider, Map<String,Object> additionalProperties)	Provide the connection to the local repository connector that maps the OMRS RepositoryConnector API to the third party persistence API.
void	setPluginRepositoryConnection(Connection connection)	Provide the connection to the local repository connector that maps the OMRS RepositoryConnector API to the third party persistence API.
void	setReadOnlyLocalRepository()	Set up an read only local repository.
void	setXTDBInMemRepository()	Set up an XTDB store as the local repository.
void	setXTDBLocalKVRepository()	Set up an XTDB store as the local repository.
void	setXTDBLocalRepository(Map<String,Object> storageProperties)	Set up an XTDB store as the local repository.

Methods inherited from class org.odpi.openmetadata.adminservices.client.MetadataAccessServerConfigurationClient

addRemoteEnterpriseTopic, clearAllAccessServices, configureAccessService, configureAccessService, configureAccessServiceNoTopics, configureAccessServiceNoTopics, configureAllAccessServices, configureAllAccessServicesNoTopics, disableAccessService, getAccessServicesConfiguration, getAccessServiceTopicNames, getAllAccessServiceTopicNames, getConfiguredAccessServices, getRegisteredAccessServices, overrideAccessServiceInTopic, overrideAccessServiceOutTopic, setAccessServicesConfig, setEnterpriseAccessConfig

Methods inherited from class org.odpi.openmetadata.adminservices.client.CohortMemberConfigurationClient

addCohortRegistration, addCohortRegistration, addStartUpOpenMetadataArchiveFile, addStartUpOpenMetadataArchiveList, clearCohortRegistration, clearLocalRepository, clearOpenMetadataArchives, getCohortTopicName, getDedicatedCohortTopicNames, getLocalMetadataCollectionId, getLocalMetadataCollectionName, overrideCohortTopicName, overrideInstancesCohortTopicName, overrideRegistrationCohortTopicName, overrideTypesCohortTopicName, resetRemoteCohortURL, setCohortConfig, setLocalMetadataCollectionId, setLocalMetadataCollectionName, setLocalRepositoryConfig

Methods inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addFileAuditLogDestination, addJDBCAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestination, clearAuditLogDestinations, clearOMAGServerConfig, clearServerSecurityConnection, deployOMAGServerConfig, getBasicServerProperties, getOMAGServerConfig, getOMAGServerInstanceConfig, getServerSecurityConnection, getServerTypeClassification, setAuditLogDestinations, setBasicServerProperties, setDefaultAuditLog, setEventBus, setMaxPageSize, setOMAGServerConfig, setOrganizationName, setServerDescription, setServerPassword, setServerSecurityConnection, setServerType, setServerURLRoot, setServerUserId, updateAuditLogDestination

Methods inherited from class java.lang.Object

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

Constructor Details

MetadataAccessStoreConfigurationClient

public MetadataAccessStoreConfigurationClient(String adminUserId,
 String serverName,
 String serverPlatformRootURL)
                                       throws OMAGInvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

Throws:

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

MetadataAccessStoreConfigurationClient

public MetadataAccessStoreConfigurationClient(String adminUserId,
 String serverName,
 String serverPlatformRootURL,
 String connectionUserId,
 String connectionPassword)
                                       throws OMAGInvalidParameterException

Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

connectionUserId - caller's system userId embedded in all HTTP requests

connectionPassword - caller's system password embedded in all HTTP requests

Throws:

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

Method Details

setInMemLocalRepository

public void setInMemLocalRepository()
                             throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException

Set up an in memory local repository. This repository uses hashmaps to store content. It is useful for demos, testing and POCs.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setGraphLocalRepository

public void setGraphLocalRepository(Map<String,Object> storageProperties)
                             throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException

Set up a graph store as the local repository. This graph store uses JanusGraph. It is scalable with different back ends and can be run in a HA context with multiple versions of the same server deployed to the same repository.

Parameters:

storageProperties - properties used to configure the back end storage for the graph

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setXTDBInMemRepository

public void setXTDBInMemRepository()
                            throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException

Set up an XTDB store as the local repository. This store uses XTDB to provide a historical metadata repository that operates in memory. This version of the XTDB repository is designed for testing.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setXTDBLocalKVRepository

public void setXTDBLocalKVRepository()
                              throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException

Set up an XTDB store as the local repository. This store uses XTDB with RocksDB KV store to provide a high performance historical metadata repository.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setXTDBLocalRepository

public void setXTDBLocalRepository(Map<String,Object> storageProperties)
                            throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException

Set up an XTDB store as the local repository. This store uses XTDB to provide a high performance historical metadata repository. It is scalable with different back ends and can be run in a HA context with multiple versions of the same server deployed to the same repository.

Parameters:

storageProperties - properties used to configure the back end storage for the repository. They are stored in the configuration properties of the local repository's connection.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setReadOnlyLocalRepository

public void setReadOnlyLocalRepository()
                                throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException

Set up an read only local repository. This repository manages metadata in memory but does not support the ability to store new metadata. This means it can safely be used to host read only content from an open metadata archive within a production cohort.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setPluginRepositoryConnection

public void setPluginRepositoryConnection(Connection connection)
                                   throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Provide the connection to the local repository connector that maps the OMRS RepositoryConnector API to the third party persistence API. The persistence layer is only called through the open metadata APIs.

Parameters:

connection - connection to the OMRS repository connector.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setPluginRepositoryConnection

public void setPluginRepositoryConnection(String connectorProvider,
 Map<String,Object> additionalProperties)
                                   throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Provide the connection to the local repository connector that maps the OMRS RepositoryConnector API to the third party persistence API. The persistence layer is only called through the open metadata APIs.

Parameters:

connectorProvider - connector provider class name to the OMRS repository connector.

additionalProperties - additional parameters to pass to the repository connector

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.