Package org.odpi.openmetadata.adminservices.client

Class RepositoryProxyConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.CohortMemberConfigurationClient

org.odpi.openmetadata.adminservices.client.RepositoryProxyConfigurationClient

public class RepositoryProxyConfigurationClient
extends CohortMemberConfigurationClient

RepositoryProxyConfigurationClient provides the configuration services for a repository proxy. This is a server that translates between the API/events of a third party metadata repository and the Open Metadata Repository Services (OMRS) API/events.

Field Summary

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

delegatingUserId, invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
RepositoryProxyConfigurationClient(String serverName, String serverPlatformRootURL, String secretStoreProvider, String secretStoreLocation, String secretStoreCollection, String delegatingUserId, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
RepositoryProxyConfigurationClient(String serverPlatformRootURL, Map<String,SecretsStoreConnector> secretsStoreConnectorMap, String delegatingUserId, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	setEventMapperConnection(String connectorProvider, String eventSource, Map<String,Object> additionalProperties)	Provide the connection to the local repository's event mapper if needed.
void	setEventMapperConnection(Connection connection)	Provide the connection to the third party repository's event mapper.
void	setRepositoryProxyConnection(String connectorProvider, Map<String,Object> additionalProperties)	Provide the connection to the third party metadata server repository connector that maps the OMRS RepositoryConnector API to the third party repository API.
void	setRepositoryProxyConnection(Connection connection)	Provide the connection to the third party metadata server repository connector that maps the OMRS RepositoryConnector API to the third party metadata server API.

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

addCohortRegistration, addStartUpOpenMetadataArchiveFile, addStartUpOpenMetadataArchiveList, clearCohortRegistration, clearLocalRepository, clearOpenMetadataArchives, getCohortTopicNames, getLocalMetadataCollectionId, getLocalMetadataCollectionName, 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

RepositoryProxyConfigurationClient

public RepositoryProxyConfigurationClient(String serverName,
 String serverPlatformRootURL,
 String secretStoreProvider,
 String secretStoreLocation,
 String secretStoreCollection,
 String delegatingUserId,
 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

delegatingUserId - external userId making request

auditLog - destination for log messages.

Throws:

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

RepositoryProxyConfigurationClient

public RepositoryProxyConfigurationClient(String serverPlatformRootURL,
 Map<String,SecretsStoreConnector> secretsStoreConnectorMap,
 String delegatingUserId,
 AuditLog auditLog)
                                   throws InvalidParameterException

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

Parameters:

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

secretsStoreConnectorMap - connectors to secrets stores

delegatingUserId - external userId making request

auditLog - destination for log messages.

Throws:

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

Method Details

setRepositoryProxyConnection

public void setRepositoryProxyConnection(Connection connection)
                                  throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Provide the connection to the third party metadata server repository connector that maps the OMRS RepositoryConnector API to the third party metadata server API.

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.

setRepositoryProxyConnection

public void setRepositoryProxyConnection(String connectorProvider,
 Map<String,Object> additionalProperties)
                                  throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Provide the connection to the third party metadata server repository connector that maps the OMRS RepositoryConnector API to the third party repository API.

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.

setEventMapperConnection

public void setEventMapperConnection(Connection connection)
                              throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Provide the connection to the third party repository's event mapper. The default value is null which means no event mapper. An event mapper is needed if the third party repository has additional APIs that can change the metadata in its repository without going through the open metadata and governance services. The event mapper detects changes to the third party repository and converts them to OMRS Events.

Parameters:

connection - connection to the OMRS repository event mapper.

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setEventMapperConnection

public void setEventMapperConnection(String connectorProvider,
 String eventSource,
 Map<String,Object> additionalProperties)
                              throws UserNotAuthorizedException,
InvalidParameterException,
OMAGConfigurationErrorException

Provide the connection to the local repository's event mapper if needed. The default value is null which means no event mapper. An event mapper is needed if the third party repository has additional APIs that can change the metadata in its repository without going through the open metadata and governance services. The event mapper detects changes to the third party repository and converts them to OMRS Events.

Parameters:

connectorProvider - Java class name of the connector provider for the OMRS repository event mapper.

eventSource - topic name or URL to the native event source.

additionalProperties - additional properties for the event mapper connection

Throws:

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

InvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.