Package org.odpi.openmetadata.adminservices.client

Class MetadataServerConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.MetadataAccessPointConfigurationClient

org.odpi.openmetadata.adminservices.client.MetadataServerConfigurationClient

public class MetadataServerConfigurationClient
extends MetadataAccessPointConfigurationClient

MetadataServerConfigurationClient provides the configuration client for a metadata server. A metadata 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
MetadataServerConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
MetadataServerConfigurationClient(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	addCohortRegistration(String cohortName, Map<String,Object> additionalProperties)	Enable registration of server to an open metadata repository cohort using the default topic structure (SINGLE_TOPIC).
void	addCohortRegistration(String cohortName, CohortTopicStructure cohortTopicStructure, Map<String,Object> additionalProperties)	Enable registration of server to an open metadata repository cohort using the topic pattern specified by cohortTopicStructure.
void	addStartUpOpenMetadataArchiveFile(String fileName)	Add a new open metadata archive file to load at startup.
void	addStartUpOpenMetadataArchiveList(List<Connection> connections)	Add a list of connections to connectors that can access an open metadata archive file.
void	clearCohortRegistration(String cohortName)	Unregister this server from an open metadata repository cohort.
void	clearLocalRepository()	Remove all configuration for a local repository.
void	clearOpenMetadataArchives()	Clear the list of open metadata archives for loading at server startup.
String	getCohortTopicName(String cohortName)	Retrieve the current topic name for the cohort.
DedicatedTopicList	getDedicatedCohortTopicNames(String cohortName)	Retrieve the current topic names for the three dedicated topics of the cohort.
String	getLocalMetadataCollectionId()	Return the local metadata collection id.
void	overrideCohortTopicName(String cohortName, String topicName)	Override the current topic name for the cohort.
void	overrideInstancesCohortTopicName(String cohortName, String topicName)	Override the current topic name for the registration topic for the cohort.
void	overrideRegistrationCohortTopicName(String cohortName, String topicName)	Override the current topic name for the registration topic for the cohort.
void	overrideTypesCohortTopicName(String cohortName, String topicName)	Override the current topic name for the registration topic for the cohort.
void	setCohortConfig(String cohortName, CohortConfig cohortConfig)	Set up the configuration properties for a cohort.
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	setLocalMetadataCollectionName(String name)	Set up the local metadata collection name.
protected void	setLocalRepositoryConfig(LocalRepositoryConfig localRepositoryConfig)	Set up the configuration for the local repository in one operation.
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.

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

clearAllAccessServices, configureAccessService, configureAccessService, configureAllAccessServices, getAccessServicesConfiguration, getAccessServiceTopicNames, getAllAccessServiceTopicNames, getConfiguredAccessServices, getRegisteredAccessServices, overrideAccessServiceInTopic, overrideAccessServiceOutTopic, setAccessServicesConfig, setEnterpriseAccessConfig

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

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestinations, clearServerSecurityConnection, deployOMAGServerConfig, getOMAGServerConfig, getOMAGServerInstanceConfig, getServerClassification, getServerSecurityConnection, setDefaultAuditLog, setEventBus, setMaxPageSize, setOMAGServerConfig, setOrganizationName, setServerPassword, setServerSecurityConnection, setServerType, setServerURLRoot, setServerUserId

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataServerConfigurationClient

public MetadataServerConfigurationClient(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.

MetadataServerConfigurationClient

public MetadataServerConfigurationClient(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 Detail

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.

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.

addCohortRegistration

public void addCohortRegistration(String cohortName,
                                  Map<String,Object> additionalProperties)
                           throws OMAGNotAuthorizedException,
                                  OMAGInvalidParameterException,
                                  OMAGConfigurationErrorException

Enable registration of server to an open metadata repository cohort using the default topic structure (SINGLE_TOPIC). A cohort is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.

Parameters:

cohortName - name of the cohort.

additionalProperties - additional properties for the event bus connection

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addCohortRegistration

public void addCohortRegistration(String cohortName,
                                  CohortTopicStructure cohortTopicStructure,
                                  Map<String,Object> additionalProperties)
                           throws OMAGNotAuthorizedException,
                                  OMAGInvalidParameterException,
                                  OMAGConfigurationErrorException

Enable registration of server to an open metadata repository cohort using the topic pattern specified by cohortTopicStructure. A cohort is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.

Parameters:

cohortName - name of the cohort

cohortTopicStructure - the style of cohort topic set up to use

additionalProperties - additional properties for the event bus connection

Throws:

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

OMAGInvalidParameterException - invalid parameter

OMAGConfigurationErrorException - unusual state in the admin server

getCohortTopicName

public String getCohortTopicName(String cohortName)
                          throws OMAGNotAuthorizedException,
                                 OMAGInvalidParameterException,
                                 OMAGConfigurationErrorException

Retrieve the current topic name for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().

Parameters:

cohortName - name of the cohort.

Returns:

string topic name

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getDedicatedCohortTopicNames

public DedicatedTopicList getDedicatedCohortTopicNames(String cohortName)
                                                throws OMAGNotAuthorizedException,
                                                       OMAGInvalidParameterException,
                                                       OMAGConfigurationErrorException

Retrieve the current topic names for the three dedicated topics of the cohort. This call can only be made once the cohort is set up with addCohortRegistration().

Parameters:

cohortName - name of the cohort.

Returns:

List of topic names - registration first, then types and then instances

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

overrideCohortTopicName

public void overrideCohortTopicName(String cohortName,
                                    String topicName)
                             throws OMAGNotAuthorizedException,
                                    OMAGInvalidParameterException,
                                    OMAGConfigurationErrorException

Override the current topic name for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().

Parameters:

cohortName - name of the cohort.

topicName - new name for the topic.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

overrideRegistrationCohortTopicName

public void overrideRegistrationCohortTopicName(String cohortName,
                                                String topicName)
                                         throws OMAGNotAuthorizedException,
                                                OMAGInvalidParameterException,
                                                OMAGConfigurationErrorException

Override the current topic name for the registration topic for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().

Parameters:

cohortName - name of the cohort.

topicName - new name for the topic.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

overrideTypesCohortTopicName

public void overrideTypesCohortTopicName(String cohortName,
                                         String topicName)
                                  throws OMAGNotAuthorizedException,
                                         OMAGInvalidParameterException,
                                         OMAGConfigurationErrorException

Override the current topic name for the registration topic for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().

Parameters:

cohortName - name of the cohort.

topicName - new name for the topic.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

overrideInstancesCohortTopicName

public void overrideInstancesCohortTopicName(String cohortName,
                                             String topicName)
                                      throws OMAGNotAuthorizedException,
                                             OMAGInvalidParameterException,
                                             OMAGConfigurationErrorException

Override the current topic name for the registration topic for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().

Parameters:

cohortName - name of the cohort.

topicName - new name for the topic.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setCohortConfig

public void setCohortConfig(String cohortName,
                            CohortConfig cohortConfig)
                     throws OMAGNotAuthorizedException,
                            OMAGInvalidParameterException,
                            OMAGConfigurationErrorException

Set up the configuration properties for a cohort. This may reconfigure an existing cohort or create a cohort. Use setCohortMode to delete a cohort.

Parameters:

cohortName - name of the cohort

cohortConfig - configuration for the cohort

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearCohortRegistration

public void clearCohortRegistration(String cohortName)
                             throws OMAGNotAuthorizedException,
                                    OMAGInvalidParameterException,
                                    OMAGConfigurationErrorException

Unregister this server from an open metadata repository cohort.

Parameters:

cohortName - name of the cohort.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addStartUpOpenMetadataArchiveFile

public void addStartUpOpenMetadataArchiveFile(String fileName)
                                       throws OMAGNotAuthorizedException,
                                              OMAGInvalidParameterException,
                                              OMAGConfigurationErrorException

Add a new open metadata archive file to load at startup.

Parameters:

fileName - name of the open metadata archive file.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

addStartUpOpenMetadataArchiveList

public void addStartUpOpenMetadataArchiveList(List<Connection> connections)
                                       throws OMAGNotAuthorizedException,
                                              OMAGInvalidParameterException,
                                              OMAGConfigurationErrorException

Add a list of connections to connectors that can access an open metadata archive file.

Parameters:

connections - list of connections to open metadata archive connectors

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearOpenMetadataArchives

public void clearOpenMetadataArchives()
                               throws OMAGNotAuthorizedException,
                                      OMAGInvalidParameterException,
                                      OMAGConfigurationErrorException

Clear the list of open metadata archives for loading at server startup.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setLocalRepositoryConfig

protected void setLocalRepositoryConfig(LocalRepositoryConfig localRepositoryConfig)
                                 throws OMAGNotAuthorizedException,
                                        OMAGInvalidParameterException,
                                        OMAGConfigurationErrorException

Set up the configuration for the local repository in one operation. This overrides the current values.

Parameters:

localRepositoryConfig - - configuration properties for the local repository.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearLocalRepository

public void clearLocalRepository()
                          throws OMAGNotAuthorizedException,
                                 OMAGInvalidParameterException,
                                 OMAGConfigurationErrorException

Remove all configuration for a local repository. The default is no local repository. This call can be used to remove subsequent local repository configuration. This call effectively sets the type of a metadata server back to a metadata access point.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setLocalMetadataCollectionName

public void setLocalMetadataCollectionName(String name)
                                    throws OMAGNotAuthorizedException,
                                           OMAGInvalidParameterException,
                                           OMAGConfigurationErrorException

Set up the local metadata collection name. If a null is passed, the connection name is cleared to null. If this is not set then the default value is the local server name.

Parameters:

name - metadata collection name.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getLocalMetadataCollectionId

public String getLocalMetadataCollectionId()
                                    throws OMAGNotAuthorizedException,
                                           OMAGInvalidParameterException,
                                           OMAGConfigurationErrorException

Return the local metadata collection id. If the local repository is not configured then the invalid parameter exception is returned.

Returns:

string guid

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.