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

invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
MetadataAccessStoreConfigurationClient(String serverName, String serverPlatformRootURL, String secretStoreProvider, String secretStoreLocation, String secretStoreCollection, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
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	setPostgreSQLLocalRepository(Map<String,Object> storageProperties)	Set up a local repository that stores metadata in PostgreSQL tables.
void	setReadOnlyLocalRepository()	Set up a read only 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, 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, 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 serverName,
 String serverPlatformRootURL,
 String secretStoreProvider,
 String secretStoreLocation,
 String secretStoreCollection,
 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

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

secretStoreProvider - class name of the secrets store

secretStoreLocation - location (networkAddress) of the secrets store

secretStoreCollection - name of the collection of secrets to use to connect to the remote server

auditLog - destination for log messages.

Throws:

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

Method Details

setInMemLocalRepository

public void setInMemLocalRepository()
                             throws UserNotAuthorizedException,
OMAGConfigurationErrorException,
InvalidParameterException

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

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setReadOnlyLocalRepository

public void setReadOnlyLocalRepository()
                                throws UserNotAuthorizedException,
OMAGConfigurationErrorException,
InvalidParameterException

Set up a 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:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setPostgreSQLLocalRepository

public void setPostgreSQLLocalRepository(Map<String,Object> storageProperties)
                                  throws UserNotAuthorizedException,
OMAGConfigurationErrorException,
InvalidParameterException

Set up a local repository that stores metadata in PostgreSQL tables. 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.

Parameters:

storageProperties - properties used to configure the back end storage for the repository Each repository is stored in its own database schema. The storage properties should include databaseURL, databaseSchema, secretsStore and secretsCollectionName

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setPluginRepositoryConnection

public void setPluginRepositoryConnection(Connection connection)
                                   throws UserNotAuthorizedException,
InvalidParameterException,
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:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setPluginRepositoryConnection

public void setPluginRepositoryConnection(String connectorProvider,
 Map<String,Object> additionalProperties)
                                   throws UserNotAuthorizedException,
InvalidParameterException,
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:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.